SecsFormat99 (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.transsecs.secs.SecsFormat99

All Implemented Interfaces:

SecsFormat
```
public class SecsFormat99
extends java.lang.Object
implements SecsFormat
```
SecsFormat99 is generated by TransSECS to hold the place for an "any" data type in VID lists and other messages. It's implementated as a pass through to a real SecsFormat object. The type of the real SecsFormat is determined from the incoming ValueObject.

Field Summary

Fields
Modifier and Type Field and Description

ValueObjectInterface theData
Mimic of SecsFormat except that "theData" is a ValueObjectInterface.

Fields
Modifier and Type	Field and Description
`ValueObjectInterface`	`theData` Mimic of SecsFormat except that "theData" is a ValueObjectInterface.

Constructor Summary

Constructors
Constructor and Description

SecsFormat99(ValueObjectInterface value)

Constructors
Constructor and Description
`SecsFormat99(ValueObjectInterface value)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static SecsFormat00`	`convertToSecsFormat(ArrayValueObject array)` Returns a SecsFormat00 from an ArrayValueObject by calling `convertSecsFormat` on each element.
`static SecsFormat`	`convertToSecsFormat(ValueObjectInterface value)` This will return a SecsFormat for a given ValueObject.
`boolean`	`equals(java.lang.Object obj)`
`SecsFormat[]`	`getArray()` This allows for arrays of secsformats (not a list of secsformats).
`boolean`	`getBoolValue()` Returns the value of the format as a boolean.
`byte`	`getByteValue()` Returns the value of the format as a byte.
`double`	`getDoubleValue()` Returns the value of the format as a double.
`float`	`getFloatValue()` Returns the value of the format as a float.
`byte[]`	`getFormattedBytes()` Returns an array of bytes suitable for use in a SECS Message.
`int`	`getIntValue()` Returns the value of the format as a int.
`int`	`getLength()` Returns the length of the format.
`long`	`getLongValue()` Returns the value of the format as a long.
`int`	`getNumberOfLengthBytes()` Returns the number of length bytes.
`short`	`getShortValue()` Returns the value of the format as a short.
`java.lang.String`	`getStringValue()` Returns the value of the format as a string.
`int`	`hashCode()`
`void`	`setArray(SecsFormat[] newValues)` This allows for a standard way to set arrays of secsformats.
`void`	`setDataFromByteArray(byte[] temp, int offset, int length)` stores the incoming value in the format object.
`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()`
`java.lang.String`	`toString(int indent)` Returns an SML string correctly indented.
`boolean`	`zeroLength()` Returns true if the format is zero length.

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

- Field Detail
  - theData
```
public ValueObjectInterface theData
```
    Mimic of SecsFormat except that "theData" is a ValueObjectInterface.
- Constructor Detail
  - SecsFormat99
```
public SecsFormat99(ValueObjectInterface value)
```
- Method Detail
  - convertToSecsFormat
```
public static SecsFormat00 convertToSecsFormat(ArrayValueObject array)
```
    Returns a SecsFormat00 from an ArrayValueObject by calling convertSecsFormat on each element.
  - convertToSecsFormat
```
public static SecsFormat convertToSecsFormat(ValueObjectInterface value)
```
    This will return a SecsFormat for a given ValueObject.
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - getArray
```
public SecsFormat[] getArray()
```
    Description copied from interface: SecsFormat
    
    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
    
    Returns:
  - getBoolValue
```
public boolean getBoolValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a boolean.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
  - getByteValue
```
public byte getByteValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a byte.
    
    Specified by:
    
    getByteValue in interface SecsFormat
    
    Returns:
  - getDoubleValue
```
public double getDoubleValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a double.
    
    Specified by:
    
    getDoubleValue in interface SecsFormat
    
    Returns:
  - getFloatValue
```
public float getFloatValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a float.
    
    Specified by:
    
    getFloatValue in interface SecsFormat
    
    Returns:
  - getFormattedBytes
```
public byte[] getFormattedBytes()
                         throws SecsException
```
    Description copied from interface: SecsFormat
    
    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
    
    Returns:
    
    Throws:
    
    SecsException
  - getIntValue
```
public int getIntValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a int.
    
    Specified by:
    
    getIntValue in interface SecsFormat
    
    Returns:
  - getLength
```
public int getLength()
```
    Description copied from interface: SecsFormat
    
    Returns the length of the format.
    
    Specified by:
    
    getLength in interface SecsFormat
    
    Returns:
  - getLongValue
```
public long getLongValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a long.
    
    Specified by:
    
    getLongValue in interface SecsFormat
    
    Returns:
  - getNumberOfLengthBytes
```
public int getNumberOfLengthBytes()
```
    Description copied from interface: SecsFormat
    
    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
    
    Returns:
  - getShortValue
```
public short getShortValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a short.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
  - getStringValue
```
public java.lang.String getStringValue()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a string.
    
    Specified by:
    
    getStringValue in interface SecsFormat
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - setArray
```
public void setArray(SecsFormat[] newValues)
              throws SecsException
```
    Description copied from interface: SecsFormat
    
    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 the SecsFormatXX doesn't acception more then one (and you sent it more then one) example: SecsFormat20 (strings) only accept 1 and lists only accept lists.
    
    Specified by:
    
    setArray in interface SecsFormat
    
    Parameters:
    
    newValues -
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException
```
    Description copied from interface: SecsFormat
    
    stores the incoming value in the format object. The method of storage is type-specific. For example, the integer classes convert the incoming byte array to integers. Format20 the ASCII format uses a String, and so forth. This method will raise a SecsException if the value cannot be converted.
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
    
    Parameters:
    
    temp -
    
    offset -
    
    length -
    
    Throws:
    
    SecsException
  - 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 -
  - setNumberOfLengthBytes
```
public void setNumberOfLengthBytes(int numberOfLengthBytes)
                            throws java.lang.IllegalArgumentException
```
    Description copied from interface: SecsFormat
    
    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 -
    
    Throws:
    
    java.lang.IllegalArgumentException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - toString
```
public java.lang.String toString(int indent)
```
    Description copied from interface: SecsFormat
    
    Returns an SML string correctly indented.
    
    Specified by:
    
    toString in interface SecsFormat
    
    Parameters:
    
    indent -
    
    Returns:
  - zeroLength
```
public boolean zeroLength()
```
    Description copied from interface: SecsFormat
    
    Returns true if the format is zero length.
    
    Specified by:
    
    zeroLength in interface SecsFormat
    
    Returns:

Class SecsFormat99

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

theData

Constructor Detail

SecsFormat99

Method Detail

convertToSecsFormat

convertToSecsFormat

equals

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

hashCode

setArray

setDataFromByteArray

setLength

setNumberOfLengthBytes

toString

toString

zeroLength