SecsFormat (ErgoTech VIB/TransSECS Scripting API)

All Known Subinterfaces:

SecsFormat3x, SecsFormat3x5x, SecsFormat4x, SecsFormat5x

All Known Implementing Classes:

ABS, ACKA, ACKC1, ACKC10, ACKC5, ACKC6, ACKC7, AGENT, ALCD, ALED, ALID, ALTX, AREYOUTHERE, ATTRDATA, ATTRID, CARRIERID, CEED, CEID, CEPACK, CEPVAL, CMDA, COMMACK, CPACK, CPNAME, CPVAL, CSAACK, CTLJOBCMD, CTLJOBID, DATAID, DATALENGTH, DRACK, DSID, DSPER, DVNAME, DVVAL, EAC, ECDEF, ECID, ECMAX, ECMIN, ECNAME, ECV, EDID, ERACK, ERRCODE, ERRTEXT, FCNID, GRANT, GRANT6, HCACK, HINTEG, LENGTH, LIMITACK, LIMITID, LIMITMAX, LIMITMIN, LINKID, LOC, LOWERDB, LRACK, LVACK, MDLN, MEXP, MF, MHEAD, MID, MMODE, OBJID, OBJSPEC, OBJTOKEN, OBJTYPE, OFLACK, ONLACK, OPID, PFCD, PODEVENT, PPBODY, PPGNT, PPID, PRCMDNAME, PREVENTID, PRJOBID, PRJOBMILESTONE, PRJOBSPACE, PRMTRLORDER, PRPAUSEEVENT, PRPROCESSSTART, PRRECIPEMETHOD, PRSTATE, RAC, RCMD, RCPATTRDATA, RCPATTRID, RCPBODY, RCPCLASS, RCPCMD, RCPDEL, RCPDESCLTH, RCPDESCNM, RCPDESCTIME, RCPID, RCPNAME, RCPNEWID, RCPOWCODE, RCPPARNM, RCPPARRULE, RCPPARVAL, RCPRENAME, RCPSECCODE, RCPSECNM, RCPSPEC, RCPSTAT, RCPUPDT, RCPVERS, REPGSZ, RESETENA, RESPEC, RIC, RMACK, RMCHGSTAT, RMCHGTYPE, RMDATASIZE, RMGRNT, RMNEWNS, RMNSCMD, RMNSSPEC, RMRECSPEC, RMREQUESTOR, RMSEGSPEC, RMSPACE, RPTID, RSDA, RSDC, RSPACK, SARM, SecsDataStructure, SecsFormat00, SecsFormat10, SecsFormat11, SecsFormat20, SecsFormat22, SecsFormat30, SecsFormat31, SecsFormat32, SecsFormat34, SecsFormat40, SecsFormat44, SecsFormat50, SecsFormat51, SecsFormat52, SecsFormat54, SecsFormat99, SFCD, SHEAD, SLOTID, SMPLN, SOFTREV, SPAACK, SPD, SPID, SPR, STIME, STRACK, STRID, SV, SVID, SVNAME, TAGSER, TAGSN, TARGETSPEC, TEXT, TIAACK, TIACK, TID, TIME, TIMEFORMAT, TIMESTAMP, TOTSMP, TRID, TSIP, TSOP, UNITS, UPPERDB, V, VID, VLAACK
```
public interface SecsFormat
```
This is the interface for all SecsFormat objects. This allows them to be manipulated in a uniform manner by the SecsII layer. This object must have a constructor that takes zero arguments. The SECS layer will use this constructor to create the object on receipt of a message and then call setDataFromByteArray on the object. If this constructor is not provided then the Secs Message will throw an exception and fail.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`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(int indent)` Returns an SML string correctly indented.
`boolean`	`zeroLength()` Returns true if the format is zero length.

- Method Detail
  - getArray
```
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).
  - getBoolValue
```
boolean getBoolValue()
```
    Returns the value of the format as a boolean.
    
    Returns:
    
    the current value
  - getByteValue
```
byte getByteValue()
```
    Returns the value of the format as a byte.
    
    Returns:
    
    the current value
  - getDoubleValue
```
double getDoubleValue()
```
    Returns the value of the format as a double.
    
    Returns:
    
    the current value
  - getFloatValue
```
float getFloatValue()
```
    Returns the value of the format as a float.
    
    Returns:
    
    the current value
  - getFormattedBytes
```
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.
    
    Throws:
    
    SecsException
  - getIntValue
```
int getIntValue()
```
    Returns the value of the format as a int.
    
    Returns:
    
    the current value
  - getLength
```
int getLength()
```
    Returns the length of the format.
    
    Returns:
    
    the length
  - getLongValue
```
long getLongValue()
```
    Returns the value of the format as a long.
    
    Returns:
    
    the current value
  - getNumberOfLengthBytes
```
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
  - getShortValue
```
short getShortValue()
```
    Returns the value of the format as a short.
    
    Returns:
    
    the current value
  - getStringValue
```
java.lang.String getStringValue()
```
    Returns the value of the format as a string.
    
    Returns:
    
    the current value
  - setArray
```
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 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.
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
void setDataFromByteArray(byte[] temp,
                          int offset,
                          int length)
                   throws SecsException
```
    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.
    
    Throws:
    
    SecsException
  - setLength
```
void setLength(int newValue)
```
    Sets the length of the format.
    
    Parameters:
    
    newValue - the new length
  - setNumberOfLengthBytes
```
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".
    
    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
```
java.lang.String toString(int indent)
```
    Returns an SML string correctly indented.
    
    Parameters:
    
    indent - the level of indentation.
  - zeroLength
```
boolean zeroLength()
```
    Returns true if the format is zero length.

Interface SecsFormat

Method Summary

Method Detail

getArray

getBoolValue

getByteValue

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

setArray

setDataFromByteArray

setLength

setNumberOfLengthBytes

toString

zeroLength