Package com.pnfsoftware.jeb.core.units.code.simatic

Enum Class S7.AreaType

java.lang.Object

java.lang.Enum<S7.AreaType>

com.pnfsoftware.jeb.core.units.code.simatic.S7.AreaType

All Implemented Interfaces:

Serializable, Comparable<S7.AreaType>, Constable

Enclosing class:

S7

@Ser
public static enum S7.AreaType
extends Enum<S7.AreaType>

Area types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DB	Shared data block area
DI	Instance data block area
I	Digital input area
L	Local data area
M	Flag memory area
PI_PQ	Peripheral input/output area
Q	Digital output area
UNKNOWN	Invalid or unknown
V	Previous local data area

Method Summary

Modifier and Type	Method	Description
static S7.AreaType	fromId(int id)	Retrieve an area type from its id.
int	getId()	Retrieve the area type id.
boolean	isAnyOf(S7.AreaType... areaTypes)	Determine whether this area type is any of the provided types.
static S7.AreaType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static S7.AreaType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final S7.AreaType UNKNOWN

Invalid or unknown

PI_PQ

public static final S7.AreaType PI_PQ

Peripheral input/output area

I

public static final S7.AreaType I

Digital input area

Q

public static final S7.AreaType Q

Digital output area

M

public static final S7.AreaType M

Flag memory area

DB

public static final S7.AreaType DB

Shared data block area

DI

public static final S7.AreaType DI

Instance data block area

L

public static final S7.AreaType L

Local data area

V

public static final S7.AreaType V

Previous local data area

Method Details

values

public static S7.AreaType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static S7.AreaType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public int getId()

Retrieve the area type id.

Returns:

area type id

fromId

public static S7.AreaType fromId(int id)

Retrieve an area type from its id.

Parameters:

id - area type id

Returns:

area type, or UNKNOWN

isAnyOf

public boolean isAnyOf(S7.AreaType... areaTypes)

Determine whether this area type is any of the provided types.

Parameters:

areaTypes - candidate area types

Returns:

true if this type matches one of the candidate types