Package com.automation_pros.odva.cip.data

Class CipUINT

java.lang.Object

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

com.automation_pros.odva.cip.data.CipUINT

All Implemented Interfaces:

BitAddressable, BoolHost

Direct Known Subclasses:

CipDATE, CipENGUNIT, CipINT, CipWORD, DynUINT, OmronBCD2

public class CipUINT
extends BaseDataType<java.lang.Short>
implements BoolHost, BitAddressable

Field Summary

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

dimensions, memberOffsets, sLogger, variantContext, varyingDimension

Constructor Summary

Constructors

Modifier	Constructor	Description
	CipUINT()
	CipUINT(int[] dimensions)
	CipUINT(short val)
protected	CipUINT(CipUINT 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).
CipUINT	copy()	Produce a deep clone of the object.
protected void	copyToImpl(BaseDataType<?> dest, int[] indices)	Support deep copy operations one element at a time.
protected void	copyToImpl(BaseDataType<?> dest, int[] toIndices, int[] fromIndices)	Support slice copy operations one element at a time.
java.lang.String	crcName()	Obtain the name of this type as used for computing structure CRCs.
java.lang.Short	get(int[] indices)	Application-side value retrieval.
boolean	getBit(int b)
boolean	getBit(int[] indices, int b)
DataDefinitionSeg	getNestingDef()	Return the element (not including array) type definition as a Path Segment, using the abbreviated form if a composite data type.
int	intValue(int... indices)	For data types 32-bits wide or less, return the best available 32-bit representation.
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.Short val)	Application-side value storage.
void	setBit(int[] indices, int b, boolean v)
void	setBit(int b, boolean v)
void	setDimensions(int[] newDimensions)	Update the lengths of the array dimensions to the given values.
void	setInt(int val, int... indices)	For data types 32-bits wide or less, set the appropriate bits from a 32-bit representation.
protected void	setPayloadImpl(java.nio.ByteBuffer source, int[] indices)	All concrete implementations must supply their per-element decoder here.
java.lang.String	structCRCString()	Logix processors don't follow CIP Volume 1 Table C-6.9 in their tag read/write routines for structures.
CipUINT	wrap(int[] indices)	Application-side wrapper for inner dimensions.

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, longValue, 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

CipUINT

public CipUINT()

CipUINT

public CipUINT(short val)

CipUINT

public CipUINT(int[] dimensions)

CipUINT

protected CipUINT(CipUINT 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.

Specified by:

getNestingDef in class BaseDataType<java.lang.Short>

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 BaseDataType<java.lang.Short>

Returns:

setDimensions

public void setDimensions(int[] newDimensions)

Description copied from class: BaseDataType

Update the lengths of the array dimensions to the given values. The number of subscripts must match the current number of subscripts. The operation must be data-preserving.

This implementation handles pure Object storage types. Anything else must override.

Overrides:

setDimensions in class BaseDataType<java.lang.Short>

structCRCString

public java.lang.String structCRCString()

Description copied from class: BaseDataType

Logix processors don't follow CIP Volume 1 Table C-6.9 in their tag read/write routines for structures. Instead, they run the CRC over comma-separated ASCII type strings that make up the structure. This is referred to in the Logix Data Access Programming Manual as the "Structure Handle".

Overrides:

structCRCString in class BaseDataType<java.lang.Short>

Returns:

getBit

public boolean getBit(int b)

Specified by:

getBit in interface BoolHost

setBit

public void setBit(int b,
                   boolean v)

Specified by:

setBit in interface BoolHost

intValue

public int intValue(int... indices)

Description copied from class: BaseDataType

For data types 32-bits wide or less, return the best available 32-bit representation. If the subscripts are incomplete, return the element with the remaining subscripts set to zero.

Overrides:

intValue in class BaseDataType<java.lang.Short>

Parameters:

indices - Array subscripts.

Returns:

setInt

public void setInt(int val,
                   int... indices)

Description copied from class: BaseDataType

For data types 32-bits wide or less, set the appropriate bits from a 32-bit representation. If the subscripts are incomplete, set the element with the remaining subscripts set to zero.

Overrides:

setInt in class BaseDataType<java.lang.Short>

Parameters:

val - New value, truncated to 8 or 16 bits if needed.

indices - Array subscripts.

get

public java.lang.Short get(int[] indices)

Description copied from class: BaseDataType

Application-side value retrieval. Subclasses must implement this function to retrieve elements of the storage array in the application data type.

Specified by:

get in class BaseDataType<java.lang.Short>

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

Returns:

set

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

Specified by:

set in class BaseDataType<java.lang.Short>

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

getBit

public boolean getBit(int[] indices,
                      int b)

Specified by:

getBit in interface BitAddressable

setBit

public void setBit(int[] indices,
                   int b,
                   boolean v)

Specified by:

setBit in interface BitAddressable

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.

Specified by:

bytesEach in class BaseDataType<java.lang.Short>

Returns:

encoded bytes per element

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.

Specified by:

setPayloadImpl in class BaseDataType<java.lang.Short>

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.

Specified by:

putPayloadImpl in class BaseDataType<java.lang.Short>

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.

Specified by:

bytesImpl in class BaseDataType<java.lang.Short>

Returns:

copy

public CipUINT copy()

Description copied from class: BaseDataType

Produce a deep clone of the object.

Specified by:

copy in class BaseDataType<java.lang.Short>

copyToImpl

protected void copyToImpl(BaseDataType<?> dest,
                          int[] indices)

Description copied from class: BaseDataType

Support deep copy operations one element at a time.

Specified by:

copyToImpl in class BaseDataType<java.lang.Short>

copyToImpl

protected void copyToImpl(BaseDataType<?> dest,
                          int[] toIndices,
                          int[] fromIndices)

Description copied from class: BaseDataType

Support slice copy operations one element at a time.

Specified by:

copyToImpl in class BaseDataType<java.lang.Short>

wrap

public CipUINT 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.

Specified by:

wrap in class BaseDataType<java.lang.Short>

Parameters:

indices - Array subscripts. Missing subscripts are allowed.