SecsFormat51 (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.secs.SecsFormat51

All Implemented Interfaces:

SecsFormat, SecsFormat3x, SecsFormat3x5x, SecsFormat5x
```
public class SecsFormat51
extends java.lang.Object
implements SecsFormat5x, SecsFormat3x5x
```
This class represents a 1-byte unsigned integer.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`
`SecsFormat[]`	`dataArray` This is the array of data if we receive an array.
`int`	`length` The length of this data, defaults to one.
`short`	`theData` The data value for this format.

Constructor Summary

Constructors
Constructor and Description
`SecsFormat51()` Creates a new object with an initial value of zero.
`SecsFormat51(byte newValue)` Create a SecsFormat51 from a byte value.
`SecsFormat51(int newValue)` Create a SecsFormat51 from an int value.
`SecsFormat51(long newValue)` Create a SecsFormat51 from a long value.
`SecsFormat51(short newValue)` Create a SecsFormat51 from a short value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)` Checks for equality of the values.
`SecsFormat[]`	`getArray()` This allows for arrays of secsformats (not a list of secsformats).
`boolean`	`getBoolValue()` Returns true if the value is non-zero, otherwise false.
`byte`	`getByteValue()` Returns the value of the data as a byte.
`double`	`getDoubleValue()` Returns the value of the data as a double.
`float`	`getFloatValue()` Returns the value of the data as a float.
`byte[]`	`getFormattedBytes()` Returns the list in a manner suitable for encoding directly into a SECS message byte stream used over SECSI or HSMS transport.
`int`	`getIntValue()` Returns the value of the data as a int.
`int`	`getLength()` Returns the number of elements in the SecsFormat00.
`long`	`getLongValue()` Returns the value of the data as a long.
`int`	`getNumberOfLengthBytes()` Returns the number of length bytes.
`short`	`getShortValue()` Returns the value of the data as a short.
`java.lang.String`	`getStringValue()` Returns a string representation of the value.
`void`	`setArray(SecsFormat[] array)` Set the data array if this is an array.
`void`	`setDataFromByteArray(byte[] temp, int offset, int length)` Interprets the data provided to create fill in an object of this type.
`void`	`setLength(int newValue)` Sets the length of format to the new value.
`void`	`setNumberOfLengthBytes(int numberOfLengthBytes)` Sets the number of length bytes to send when the format is encoded.
`java.lang.String`	`toString()` Returns the SML string representing this value
`java.lang.String`	`toString(int indentCount)` Returns the indented SML string representing this value.
`boolean`	`zeroLength()` Ask if the list is a zero length list.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
  - dataArray
```
public SecsFormat[] dataArray
```
    This is the array of data if we receive an array. The 0th element is also stored in theData so that you can use the first element the same way as always.
  - length
```
public int length
```
    The length of this data, defaults to one.
  - theData
```
public short theData
```
    The data value for this format.
- Constructor Detail
  - SecsFormat51
```
public SecsFormat51()
```
    Creates a new object with an initial value of zero.
  - SecsFormat51
```
public SecsFormat51(byte newValue)
```
    Create a SecsFormat51 from a byte value.
  - SecsFormat51
```
public SecsFormat51(int newValue)
```
    Create a SecsFormat51 from an int value.
  - SecsFormat51
```
public SecsFormat51(long newValue)
```
    Create a SecsFormat51 from a long value.
  - SecsFormat51
```
public SecsFormat51(short newValue)
```
    Create a SecsFormat51 from a short value.
- Method Detail
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Checks for equality of the values.
    
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getArray
```
public SecsFormat[] getArray()
```
    This allows for arrays of secsformats (not a list of secsformats). This will ALWAYS return an valid array... but if the SecsFormat has only one element, it will return an array of secsformats with one element (itself).
    
    Specified by:
    
    getArray in interface SecsFormat
  - getBoolValue
```
public boolean getBoolValue()
```
    Returns true if the value is non-zero, otherwise false.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
    
    the value as a boolean.
  - getByteValue
```
public byte getByteValue()
```
    Returns the value of the data as a byte. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getByteValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the value of the data as a double. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getDoubleValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getFloatValue
```
public float getFloatValue()
```
    Returns the value of the data as a float. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getFloatValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getFormattedBytes
```
public byte[] getFormattedBytes()
```
    Returns the list in a manner suitable for encoding directly into a SECS message byte stream used over SECSI or HSMS transport.
    
    Specified by:
    
    getFormattedBytes in interface SecsFormat
    
    Returns:
    
    a SECSII formatted byte array.
  - getIntValue
```
public int getIntValue()
```
    Returns the value of the data as a int. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getIntValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getLength
```
public int getLength()
```
    Returns the number of elements in the SecsFormat00.
    
    Specified by:
    
    getLength in interface SecsFormat
    
    Returns:
    
    the length of the format
  - getLongValue
```
public long getLongValue()
```
    Returns the value of the data as a long. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getLongValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getNumberOfLengthBytes
```
public int getNumberOfLengthBytes()
```
    Returns the number of length bytes. This will return -1 if the default number of length bytes are to be used, otherwise it will return 1, 2, or 3
    
    Specified by:
    
    getNumberOfLengthBytes in interface SecsFormat
  - getShortValue
```
public short getShortValue()
```
    Returns the value of the data as a short. This method will print an error and return truncated data if the value cannot be converted to this format or there is a loss of precision.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
    
    the current value
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns a string representation of the value.
    
    Specified by:
    
    getStringValue in interface SecsFormat
    
    Returns:
    
    the current value
  - setArray
```
public void setArray(SecsFormat[] array)
              throws SecsException
```
    Set the data array if this is an array.
    
    Specified by:
    
    setArray in interface SecsFormat
    
    Specified by:
    
    setArray in interface SecsFormat3x
    
    Specified by:
    
    setArray in interface SecsFormat5x
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException
```
    Interprets the data provided to create fill in an object of this type.
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
    
    Parameters:
    
    temp - SECSII formatted data.
    
    Throws:
    
    SecsException
  - setLength
```
public void setLength(int newValue)
```
    Sets the length of format to the new value.
    
    Specified by:
    
    setLength in interface SecsFormat
    
    Parameters:
    
    newValue - the new length
  - setNumberOfLengthBytes
```
public void setNumberOfLengthBytes(int numberOfLengthBytes)
                            throws java.lang.IllegalArgumentException
```
    Sets the number of length bytes to send when the format is encoded. The SecsFormat will normally send the minimum number of length bytes required for the format. This allows that to be overridden so a different number of length bytes can be send. The only available number for the length bytes are -1, 1, 2 or 3. A value of -1 indicates that the default number of length bytes should be used. Any other value will throw an "IllegalArgumentException".
    
    Specified by:
    
    setNumberOfLengthBytes in interface SecsFormat
    
    Parameters:
    
    numberOfLengthBytes - the new number of length bytes. This should be 1, 2,3 or -1 to indicate the default
    
    Throws:
    
    java.lang.IllegalArgumentException - if the value is not 1, 2, 3 or -1
  - toString
```
public java.lang.String toString()
```
    Returns the SML string representing this value
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
  - toString
```
public java.lang.String toString(int indentCount)
```
    Returns the indented SML string representing this value.
    
    Specified by:
    
    toString in interface SecsFormat
    
    Parameters:
    
    the - indentation
    
    Returns:
  - zeroLength
```
public boolean zeroLength()
```
    Ask if the list is a zero length list.
    
    Specified by:
    
    zeroLength in interface SecsFormat
    
    Returns:
    
    true if the format is zero length, otherwise false

Class SecsFormat51

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsRev

dataArray

length

theData

Constructor Detail

SecsFormat51

SecsFormat51

SecsFormat51

SecsFormat51

SecsFormat51

Method Detail

equals

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

setArray

setDataFromByteArray

setLength

setNumberOfLengthBytes

toString

toString

zeroLength