Package com.automation_pros.odva.cip.data

Class CipSGNODO

java.lang.Object

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

com.automation_pros.odva.cip.data.CipULINT

com.automation_pros.odva.cip.data.CipSGNODO

All Implemented Interfaces:

BitAddressable, BoolHost

Direct Known Subclasses:

CipODO

public class CipSGNODO
extends CipULINT

Field Summary

Fields

Modifier and Type	Field	Description
static long	MODULUS
static long	NMODULUS

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

dimensions, memberOffsets, sLogger, variantContext, varyingDimension

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	bytesEach()	Obtain the bytes-per-element of this object's payload encoding.
protected int	bytesImpl(int[] indices)	Retrieve the bytes payload size of a single array element (or sole element).
CipSGNODO	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.
protected void	putPayloadImpl(java.nio.ByteBuffer dest, int[] indices)	All concrete implementations must supply their per-element encoder here.
void	set(int[] indices, java.lang.Long val)	Application-side value storage.
protected void	setPayloadImpl(java.nio.ByteBuffer source, int[] indices)	All concrete implementations must supply their per-element decoder here.
CipSGNODO	wrap(int[] indices)	Application-side wrapper for inner dimensions.

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

copyToImpl, copyToImpl, get, getBit, getBit, longValue, setBit, setBit, setDimensions, setLong, 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, intValue, linear2dim, linear2dim, makeInstance, maxEach, minEach, nestedBytes, nestedBytesEach, nestedBytesImpl, nestedPutPayload, nestedPutPayloadImpl, nestedSetPayload, nestedSetPayloadImpl, putAbbrevType, putPayload, range2suffix, rawCRC16, set, setFromTokenImpl, setFromTokenizer, setFromTokenizerImpl, setFromTokenString, setInt, 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

Field Detail

MODULUS

public static final long MODULUS

See Also:

Constant Field Values

NMODULUS

public static final long NMODULUS

See Also:

Constant Field Values

Constructor Detail

CipSGNODO

public CipSGNODO()

CipSGNODO

public CipSGNODO(long val)

CipSGNODO

public CipSGNODO(int[] dimensions)

CipSGNODO

protected CipSGNODO(CipSGNODO data,
                    int[] indices)

Method Detail

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 CipULINT

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 CipULINT

Returns:

bytesEach

public int bytesEach()

Description copied from class: BaseDataType

Obtain the bytes-per-element of this object's payload encoding. Objects with variable length encodings must return zero and implement the bytesImpl(), minEach(), maxEach(), and alignment() methods instead.

Overrides:

bytesEach in class CipULINT

Returns:

encoded bytes per element

set

public void set(int[] indices,
                java.lang.Long 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 CipULINT

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

setPayloadImpl

protected void setPayloadImpl(java.nio.ByteBuffer source,
                              int[] indices)

Description copied from class: BaseDataType

All concrete implementations must supply their per-element decoder here.

Overrides:

setPayloadImpl in class CipULINT

putPayloadImpl

protected void putPayloadImpl(java.nio.ByteBuffer dest,
                              int[] indices)

Description copied from class: BaseDataType

All concrete implementations must supply their per-element encoder here.

Overrides:

putPayloadImpl in class CipULINT

bytesImpl

protected int bytesImpl(int[] indices)

Description copied from class: BaseDataType

Retrieve the bytes payload size of a single array element (or sole element). Objects with fixed element sizes may simply return bytesEach() here.

Overrides:

bytesImpl in class CipULINT

Returns:

copy

public CipSGNODO copy()

Description copied from class: BaseDataType

Produce a deep clone of the object.

Overrides:

copy in class CipULINT

wrap

public CipSGNODO 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 CipULINT

Parameters:

indices - Array subscripts. Missing subscripts are allowed.