org.llrp.ltk.generated.enumerations
Class GPIPortState

java.lang.Object
  extended by org.llrp.ltk.types.LLRPType
      extended by org.llrp.ltk.types.LLRPNumberType
          extended by org.llrp.ltk.types.UnsignedByte
              extended by org.llrp.ltk.generated.enumerations.GPIPortState
All Implemented Interfaces:
LLRPEnumeration

public class GPIPortState
extends UnsignedByte
implements LLRPEnumeration

GPIPortState is Enumeration of Type UnsignedByte


Field Summary
static int High
           
static int Low
           
static int Unknown
           
 
Fields inherited from class org.llrp.ltk.types.UnsignedByte
value
 
Fields inherited from class org.llrp.ltk.types.LLRPNumberType
signed
 
Constructor Summary
GPIPortState()
           
GPIPortState(org.jdom.Element element)
          Create new GPIPortState by passing jdom element.
GPIPortState(int value)
          Create new GPIPortState by passing integer value.
GPIPortState(LLRPBitList list)
          Create new GPIPortState by passing LLRPBitList.
GPIPortState(java.lang.String name)
          Create new GPIPortState by passing a string.
 
Method Summary
 org.jdom.Content encodeXML(java.lang.String name, org.jdom.Namespace ns)
          create xml representation of this parameter.
 java.lang.String getName(int value)
          get name of a value if no name can be found for given value return empty string.
 int getValue(java.lang.String name)
          get value of a name representing a value if no value can be found, return -1.
 boolean isValidName(java.lang.String name)
          check if the name stands for an allowed value of this enumeration.
 boolean isValidValue(int value)
          check if a value is allowed for an enumeration.
static int length()
          number of bits used to represent this type.
 void set(int value)
          set the current value of this enumeration to the value given.
 void set(java.lang.String name)
          set the current value of this enumeration to the value identified by given string.
 java.lang.String toString()
          String representation
 
Methods inherited from class org.llrp.ltk.types.UnsignedByte
decodeBinary, decodeXML, encodeBinary, inRange, inRange, toByte, toInteger, toString
 
Methods inherited from class org.llrp.ltk.types.LLRPNumberType
equals, hashCode, intValue
 
Methods inherited from class org.llrp.ltk.types.LLRPType
toXMLString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.llrp.ltk.types.LLRPEnumeration
intValue
 

Field Detail

Low

public static final int Low
See Also:
Constant Field Values

High

public static final int High
See Also:
Constant Field Values

Unknown

public static final int Unknown
See Also:
Constant Field Values
Constructor Detail

GPIPortState

public GPIPortState()

GPIPortState

public GPIPortState(int value)
Create new GPIPortState by passing integer value.

Parameters:
value - an Integer value allowed - might check first with isValidValue it it is an allowed value
Throws:
java.lang.IllegalArgumentException - if the value is not allowed for this enumeration

GPIPortState

public GPIPortState(org.jdom.Element element)
Create new GPIPortState by passing jdom element.

Parameters:
element - - jdom element where the child is a string that is the name for a value of the enumeration.
Throws:
java.lang.IllegalArgumentException - if the value found in element is not allowed for this enumeration.

GPIPortState

public GPIPortState(java.lang.String name)
Create new GPIPortState by passing a string.

Throws:
java.lang.IllegalArgumentException - if the string does not stand for a valid value.

GPIPortState

public GPIPortState(LLRPBitList list)
Create new GPIPortState by passing LLRPBitList.

Parameters:
list - - LLRPBitList
Throws:
java.lang.IllegalArgumentException - if the value found in the BitList is not allowed for this enumeration.
Method Detail

set

public final void set(java.lang.String name)
set the current value of this enumeration to the value identified by given string.

Specified by:
set in interface LLRPEnumeration
Parameters:
name - set this enumeration to hold one of the allowed values
Throws:
java.lang.IllegalArgumentException - if the value found for given String is not allowed for this enumeration.

set

public final void set(int value)
set the current value of this enumeration to the value given.

Specified by:
set in interface LLRPEnumeration
Parameters:
value - to be set
Throws:
java.lang.IllegalArgumentException - if the value is not allowed for this enumeration.

encodeXML

public org.jdom.Content encodeXML(java.lang.String name,
                                  org.jdom.Namespace ns)
create xml representation of this parameter.

Overrides:
encodeXML in class UnsignedByte
Parameters:
name - returned content should have
ns - Namespace of elements

toString

public java.lang.String toString()
String representation

Specified by:
toString in interface LLRPEnumeration
Overrides:
toString in class UnsignedByte
Returns:
String

isValidValue

public boolean isValidValue(int value)
check if a value is allowed for an enumeration.

Specified by:
isValidValue in interface LLRPEnumeration
Parameters:
value - to set
Returns:
boolean

getValue

public final int getValue(java.lang.String name)
get value of a name representing a value if no value can be found, return -1.

Specified by:
getValue in interface LLRPEnumeration
Parameters:
name - for value
Returns:
int

getName

public final java.lang.String getName(int value)
get name of a value if no name can be found for given value return empty string.

Specified by:
getName in interface LLRPEnumeration
Parameters:
value - of name
Returns:
String

isValidName

public boolean isValidName(java.lang.String name)
check if the name stands for an allowed value of this enumeration.

Specified by:
isValidName in interface LLRPEnumeration
Parameters:
name - to check
Returns:
boolean

length

public static int length()
number of bits used to represent this type.

Returns:
Integer


Copyright © 2007 ETH Zurich.