Package com.automation_pros.odva.cip.data

Class CipEPATH

java.lang.Object

com.automation_pros.odva.cip.data.BaseDataType<CipPath>

com.automation_pros.odva.cip.data.CipEPATH

Direct Known Subclasses:

CipEPATH.CipPadEPATH, DynEPATH

public class CipEPATH
extends BaseDataType<CipPath>

Packed and Padded EPath implementation, with variants, with options for no length prefix, an USINT length, or an UINT length. Defaults to an UINT length prefix for constructors that don't specify it.

Author:

philip

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CipEPATH.CipPadEPATH

Field Summary

Fields

Modifier and Type	Field	Description
boolean	padded

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

dimensions, memberOffsets, sLogger, variantContext, varyingDimension

Constructor Summary

Constructors

Modifier	Constructor	Description
	CipEPATH()
	CipEPATH(boolean padded)
	CipEPATH(boolean padded, int[] dimensions)
	CipEPATH(boolean padded, CipPath path)
	CipEPATH(int[] dimensions)
protected	CipEPATH(CipEPATH 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).
CipEPATH	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.
CipPath	get(int[] indices)	Application-side value retrieval.
DataDefinitionSeg	getNestingDef()	Return the element (not including array) type definition as a Path Segment, using the abbreviated form if a composite data type.
void	putPayload(java.nio.ByteBuffer dest, int... indices)	All CIP datatypes must provide bytestream payloads.
protected void	putPayloadImpl(java.nio.ByteBuffer dest, int[] indices)	All concrete implementations must supply their per-element encoder here.
void	set(int[] indices, CipPath val)	Application-side value storage.
void	setPayload(java.nio.ByteBuffer source, int... indices)	Decode a value from specification wire format to instance storage.
protected void	setPayloadImpl(java.nio.ByteBuffer source, int[] indices)	All concrete implementations must supply their per-element decoder here.
CipEPATH	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, intValue, linear2dim, linear2dim, longValue, makeInstance, maxEach, minEach, nestedBytes, nestedBytesEach, nestedBytesImpl, nestedPutPayload, nestedPutPayloadImpl, nestedSetPayload, nestedSetPayloadImpl, putAbbrevType, range2suffix, rawCRC16, set, setDimensions, setFromTokenImpl, setFromTokenizer, setFromTokenizerImpl, setFromTokenString, setInt, setLong, setMemberOffsets, setupTokenizer, setVariantContext, setVariantDimension, setVariantDimension, singleToString, sliceTo, structCRCString, toString

Methods inherited from class java.lang.Object

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

Field Detail

padded

public final boolean padded

Constructor Detail

CipEPATH

public CipEPATH()

CipEPATH

public CipEPATH(boolean padded)

CipEPATH

public CipEPATH(boolean padded,
                CipPath path)

CipEPATH

public CipEPATH(int[] dimensions)

CipEPATH

public CipEPATH(boolean padded,
                int[] dimensions)

CipEPATH

protected CipEPATH(CipEPATH 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<CipPath>

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<CipPath>

Returns:

get

public CipPath 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<CipPath>

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

Returns:

set

public void set(int[] indices,
                CipPath 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<CipPath>

Parameters:

indices - Array subscripts. Missing subscripts not allowed.

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<CipPath>

Returns:

encoded bytes per element

setPayload

public void setPayload(java.nio.ByteBuffer source,
                       int... indices)

Description copied from class: BaseDataType

Decode a value from specification wire format to instance storage.

Overrides:

setPayload in class BaseDataType<CipPath>

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<CipPath>

putPayload

public void putPayload(java.nio.ByteBuffer dest,
                       int... indices)

Description copied from class: BaseDataType

All CIP datatypes must provide bytestream payloads. When an array, and fewer indices are supplied than dimensions, multiple consecutive payloads are to be written from the array into the destination buffer.

Overrides:

putPayload in class BaseDataType<CipPath>

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<CipPath>

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<CipPath>

Returns:

copy

public CipEPATH copy()

Description copied from class: BaseDataType

Produce a deep clone of the object.

Specified by:

copy in class BaseDataType<CipPath>

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<CipPath>

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<CipPath>

wrap

public CipEPATH 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<CipPath>

Parameters:

indices - Array subscripts. Missing subscripts are allowed.