Package com.automation_pros.odva.cip.data

Class CipTOD

java.lang.Object

com.automation_pros.odva.cip.data.BaseDataType<java.lang.Integer>

com.automation_pros.odva.cip.data.CipUDINT

com.automation_pros.odva.cip.data.CipDINT

com.automation_pros.odva.cip.data.CipTOD

All Implemented Interfaces:

BitAddressable, BoolHost

public class CipTOD
extends CipDINT

CIP TIME_OF_DAY

This type, encoded as an unsigned 32-bit integer, represents milliseconds since midnight on an arbitrary day. No allowance for time zones or DST changes is included.

Field Summary

Fields inherited from class com.automation_pros.odva.cip.data.BaseDataType

dimensions, memberOffsets, sLogger, variantContext, varyingDimension

Constructor Summary

Constructors

Modifier	Constructor	Description
	CipTOD()
	CipTOD(int val)
	CipTOD(int[] dimensions)
protected	CipTOD(CipTOD data, int[] indices)

Method Summary

Modifier and Type	Method	Description
CipTOD	copy()	Produce a deep clone of the object.
java.lang.String	crcName()	Obtain the name of this type as used for computing structure CRCs.
DataDefinitionSeg	getNestingDef()	Return the element (not including array) type definition as a Path Segment, using the abbreviated form if a composite data type.
void	set(int[] indices, java.lang.Integer val)	Application-side value storage.
CipTOD	wrap(int[] indices)	Application-side wrapper for inner dimensions.

Methods inherited from class com.automation_pros.odva.cip.data.CipDINT

longValue

Methods inherited from class com.automation_pros.odva.cip.data.CipUDINT

bytesEach, bytesImpl, copyToImpl, copyToImpl, get, getBit, getBit, intValue, putPayloadImpl, setBit, setBit, setDimensions, setInt, setPayloadImpl, structCRCString

Methods inherited from class com.automation_pros.odva.cip.data.BaseDataType

alignment, browseInner, browseInnerImpl, bytes, checkDimensions, chkAbbrevType, concatIndices, conditionalSuffix, copyTo, CRC16, CRC16, CRC16, dim2linear, dim2linear, dim2qty, dim2suffix, dimensionToString, doubleValue, extendIntArray, fillIntArray, get, getCompleteDef, getDimensions, getMemberOffsets, getSymbolType, getTypeCode, getVariantContext, getVaryingDimension, hasOffset, incIdx, intArray, linear2dim, linear2dim, makeInstance, maxEach, minEach, nestedBytes, nestedBytesEach, nestedBytesImpl, nestedPutPayload, nestedPutPayloadImpl, nestedSetPayload, nestedSetPayloadImpl, putAbbrevType, putPayload, range2suffix, rawCRC16, set, setFromTokenImpl, setFromTokenizer, setFromTokenizerImpl, setFromTokenString, setLong, setMemberOffsets, setPayload, setupTokenizer, setVariantContext, setVariantDimension, setVariantDimension, singleToString, sliceTo, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CipTOD

public CipTOD()

CipTOD

public CipTOD(int val)

CipTOD

public CipTOD(int[] dimensions)

CipTOD

protected CipTOD(CipTOD data,
                 int[] indices)

Method Detail

set

public void set(int[] indices,
                java.lang.Integer val)

Description copied from class: BaseDataType

Application-side value storage. Subclasses must implement this function to store one value or complex element into the storage array.

Overrides:

set in class CipUDINT

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

getNestingDef

public DataDefinitionSeg getNestingDef()

Description copied from class: BaseDataType

Return the element (not including array) type definition as a Path Segment, using the abbreviated form if a composite data type.

Overrides:

getNestingDef in class CipDINT

crcName

public java.lang.String crcName()

Description copied from class: BaseDataType

Obtain the name of this type as used for computing structure CRCs. Can be different from the name(s) used by the CipPath parser.

Overrides:

crcName in class CipDINT

Returns:

copy

public CipTOD copy()

Description copied from class: BaseDataType

Produce a deep clone of the object.

Overrides:

copy in class CipDINT

wrap

public CipTOD wrap(int[] indices)

Description copied from class: BaseDataType

Application-side wrapper for inner dimensions. Implementations must update memberOffsets if not not using the protected constructor.

Overrides:

wrap in class CipDINT

Parameters:

indices - Array subscripts. Missing subscripts are allowed.