SecsDataStructure (ErgoTech VIB/TransSECS Scripting API)

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

All Implemented Interfaces:

SecsFormat, java.io.Serializable

Direct Known Subclasses:

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, 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 abstract class SecsDataStructure
extends java.lang.Object
implements SecsFormat, java.io.Serializable
```
This is the abstract superclass of all secs data structures (SVID, VID, SV, ect) Each subclass must implement the following to work with the rest of the system... 1) implement a constructor that takes a SecsFormat. This is used to automatically create the data structure after its been converted to bytes. 2) this constructor should check types. This is useful since others might use the constructor 3)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String cvsRev

SecsFormat theData

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`cvsRev`
`SecsFormat`	`theData`

Constructor Summary

Constructors
Constructor and Description

SecsDataStructure()

Constructors
Constructor and Description
`SecsDataStructure()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object newData)` Performs a comparision of this object to an object of the same type.
`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.
`SecsFormat`	`getData()` Return the raw SecsFormat object.
`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 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 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)` This is only be called on the raw secsFormat classes.
`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, notify, notifyAll, wait, wait, wait

- Field Detail
  - cvsRev
```
public static final java.lang.String cvsRev
```
    See Also:
    
    Constant Field Values
  - theData
```
public SecsFormat theData
```
- Constructor Detail
  - SecsDataStructure
```
public SecsDataStructure()
```
- Method Detail
  - equals
```
public boolean equals(java.lang.Object newData)
```
    Performs a comparision of this object to an object of the same type. This method checks that the classes of the data are the same and that the values they contain are the same. The values being the same is defined as the toString of the value returning strings that the String method "equals" returns true for. Some subclasses override this method to provide a more relaxed comparision. In particular they will generally not check the class so that the floating point value 1.23 will be equal to the string value "1.23".
    
    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()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a boolean.
    
    Specified by:
    
    getBoolValue in interface SecsFormat
    
    Returns:
    
    the current value
  - 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:
    
    the current value
  - getData
```
public SecsFormat getData()
```
    Return the raw SecsFormat object.
    
    Returns:
    
    the raw SecsFormat object.
  - 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:
    
    the current value
  - 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:
    
    the current value
  - getFormattedBytes
```
public byte[] getFormattedBytes()
                         throws SecsException
```
    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.
    
    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:
    
    the current value
  - 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()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a long.
    
    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()
```
    Description copied from interface: SecsFormat
    
    Returns the value of the format as a short.
    
    Specified by:
    
    getShortValue in interface SecsFormat
    
    Returns:
    
    the current value
  - 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:
    
    the current value
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - 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 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
    
    Throws:
    
    SecsException
  - setDataFromByteArray
```
public void setDataFromByteArray(byte[] temp,
                                 int offset,
                                 int length)
                          throws SecsException
```
    This is only be called on the raw secsFormat classes. Most secsdatastructures objects don't know what form the thedata will be stored until the constructor is called (a sv can store every type of SecsFormat as its data)
    
    Specified by:
    
    setDataFromByteArray in interface SecsFormat
    
    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 - 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 SecsDataStructure

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cvsRev

theData

Constructor Detail

SecsDataStructure

Method Detail

equals

getArray

getBoolValue

getByteValue

getData

getDoubleValue

getFloatValue

getFormattedBytes

getIntValue

getLength

getLongValue

getNumberOfLengthBytes

getShortValue

getStringValue

hashCode

setArray

setDataFromByteArray

setLength

setNumberOfLengthBytes

toString

toString

zeroLength