SecsFormat10 (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

SecsFormat
```
public class SecsFormat10
extends java.lang.Object
implements SecsFormat
```
This class holds binary data. It will hold single element binary data and has constructors to make creation of objects holding a single byte easy. It can also be used to store an array of data.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String cvsRev

byte[] theData

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`
`byte[]`	`theData`

Constructor Summary

Constructors
Constructor and Description
`SecsFormat10()` Required empty constructor.
`SecsFormat10(boolean b1)` Construct a SecsFormat10 that has a single byte representing the value of the binary data.
`SecsFormat10(boolean b1, boolean b2, boolean b3, boolean b4, boolean b5, boolean b6, boolean b7, boolean b8)` Construct a SecsFormat10 that has a single byte representing the bits passed.
`SecsFormat10(byte newValue)` Construct a SecsFormat10 that has a single byte representing the byte passed.
`SecsFormat10(byte[] newValue)` Construct a SecsFormat10 from the byte array passed.
`SecsFormat10(int newValue)` Construct a SecsFormat10 that has a single byte representing the int passed.
`SecsFormat10(java.lang.String theString)` This constructor will take either a unsigned byte (value between 0 - 255) or a hex value (0xAA).

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`booleanValue()` Returns the boolean representation of the object.
`boolean`	`equals(java.lang.Object secsFormat10)` This method will compare the arrays of two SecsFormat10 objects.
`SecsFormat[]`	`getArray()` This allows for arrays of secsformats (not a list of secsformats).
`boolean`	`getBoolValue()` Returns the boolean representation of the object.
`byte`	`getByteValue()` Returns the first element of array as a byte.
`double`	`getDoubleValue()` Returns the first element of array as a double.
`float`	`getFloatValue()` Returns the first element of array as a float.
`byte[]`	`getFormattedBytes()` Returns an array of bytes suitable for use in a SECS Message.
`int`	`getIntValue()` Returns the first element of array as an int.
`int`	`getLength()` Returns the length of the format.
`long`	`getLongValue()` Returns the first element of array as a long.
`int`	`getNumberOfLengthBytes()` Returns the number of length bytes.
`short`	`getShortValue()` Returns the first element of array as a short.
`java.lang.String`	`getStringValue()` Returns the string representation of the object.
`void`	`setArray(SecsFormat[] newValues)` This allows for a standard way to set arrays of secsformats.
`void`	`setDataFromByteArray(byte[] temp, int offset, int length)` Set the variable from an array of bytes.
`void`	`setLength(int newValue)` Sets the length of the format.
`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()` Returns true if the format is zero length.

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
  - theData
```
public byte[] theData
```
- Constructor Detail
  - SecsFormat10
```
public SecsFormat10()
```
    Required empty constructor.
  - SecsFormat10
```
public SecsFormat10(boolean b1)
```
    Construct a SecsFormat10 that has a single byte representing the value of the binary data.
  - SecsFormat10
```
public SecsFormat10(boolean b1,
                    boolean b2,
                    boolean b3,
                    boolean b4,
                    boolean b5,
                    boolean b6,
                    boolean b7,
                    boolean b8)
```
    Construct a SecsFormat10 that has a single byte representing the bits passed. The binary data will have a one representing each true bit, and a zero for each false bit. For example, if b1, b5 and b8 are true then the first (and only) byte of the data will have the value 0x91.
  - SecsFormat10
```
public SecsFormat10(byte newValue)
```
    Construct a SecsFormat10 that has a single byte representing the byte passed.
  - SecsFormat10
```
public SecsFormat10(byte[] newValue)
```
    Construct a SecsFormat10 from the byte array passed.
  - SecsFormat10
```
public SecsFormat10(int newValue)
```
    Construct a SecsFormat10 that has a single byte representing the int passed.
  - SecsFormat10
```
public SecsFormat10(java.lang.String theString)
```
    This constructor will take either a unsigned byte (value between 0 - 255) or a hex value (0xAA). If the string has more then one value, they MUST be comma delimited (0xAA, 164, 0x01, 2) *you can mix and match hex and unsigned byte values.
- Method Detail
  - booleanValue
```
public boolean booleanValue()
```
    Returns the boolean representation of the object.
    
    Returns:
    
    true if the first element of the data is non-zero, otherwise false.
  - equals
```
public boolean equals(java.lang.Object secsFormat10)
```
    This method will compare the arrays of two SecsFormat10 objects. If the objects are both SecsFormat10's, the arrays are the same length and the elements are the same then this method returns true, otherwise false.
    
    Overrides:
    
    equals in class 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 the boolean representation of the object.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
    
    true if the first element of the data is non-zero, otherwise false.
  - getByteValue
```
public byte getByteValue()
```
    Returns the first element of array as a byte.
    
    Specified by:
    
    getByteValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the first element of array as a double.
    
    Specified by:
    
    getDoubleValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - getFloatValue
```
public float getFloatValue()
```
    Returns the first element of array as a float.
    
    Specified by:
    
    getFloatValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - getFormattedBytes
```
public byte[] getFormattedBytes()
                         throws SecsException
```
    Returns an array of bytes suitable for use in a SECS Message. This includes the header containing the type/length information.
    
    Specified by:
    
    getFormattedBytes in interface SecsFormat
    
    Throws:
    
    SecsException
  - getIntValue
```
public int getIntValue()
```
    Returns the first element of array as an int.
    
    Specified by:
    
    getIntValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - getLength
```
public int getLength()
```
    Description copied from interface: SecsFormat
    
    Returns the length of the format.
    
    Specified by:
    
    getLength in interface SecsFormat
    
    Returns:
    
    the length
  - getLongValue
```
public long getLongValue()
```
    Returns the first element of array as a long.
    
    Specified by:
    
    getLongValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - 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 first element of array as a short.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
    
    the first element of the object.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Returns the string representation of the object. This will either be the number as an unsigned byte (154 or 23 or 99) if there is only one value, or it will be a comma delimited string of hex values (0x4A, 0x61, 0x0B ect.) it will also add a '\n' every 10 values to make it a little more readable
    
    Specified by:
    
    getStringValue in interface SecsFormat
    
    Returns:
    
    the value as a string.
  - setArray
```
public void setArray(SecsFormat[] newValues)
              throws SecsException
```
    This allows for a standard way to set arrays of secsformats. This should also be valid if an array of one element be set. This will throw a secs exception if the secsformats are invalid or if (We will only accept a 1 element array with a SecsFormat10 in it.
    
    Specified by:
    
    setArray in interface SecsFormat
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException
```
    Set the variable from an array of bytes.
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
    
    Throws:
    
    SecsException - thrown if the length of the data array is not sufficient to hold the data. this will occur if the offset is greater that temp.length or if offset+length is greater than temp.length. In the first case the data will be invalid. In the second case the data will be valid to the maximum extent possible, that is temp.length-(length+offet) bytes will be valid.
  - setLength
```
public void setLength(int newValue)
```
    Description copied from interface: SecsFormat
    
    Sets the length of the format.
    
    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()
  
  Description copied from interface: SecsFormat
  
  Returns true if the format is zero length.
  
  Specified by:
  
  zeroLength in interface SecsFormat

Class SecsFormat10

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsRev

theData

Constructor Detail

SecsFormat10

SecsFormat10

SecsFormat10

SecsFormat10

SecsFormat10

SecsFormat10

SecsFormat10

Method Detail

booleanValue

equals

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

setArray

setDataFromByteArray

setLength

setNumberOfLengthBytes

toString

toString

zeroLength