Package com.automation_pros.odva.cip.path

Class OmStringDefSeg

  • All Implemented Interfaces:
    java.lang.Comparable<PathSegment>
    public class OmStringDefSeg
extends DataDefinitionSeg
    Encapsulates an elementary data type annotation within a CIP Path definition. Type annotations are generally not passed on the wire, but delimit the path fragment that will go on the wire (before the data type) from the path fragment that will be applied to the payload on the wire.

    • Field Detail

      • locked

        protected boolean locked

      • allocation

        protected int allocation

    • Constructor Detail

      • OmStringDefSeg

        public OmStringDefSeg()

      • OmStringDefSeg

        protected OmStringDefSeg​(int allocation)

    • Method Detail

      • getCached

        public static OmStringDefSeg getCached​(int allocation)

      • getAllocation

        public int getAllocation()

      • getSizeImpl

        protected int getSizeImpl​(DataContext ctx)
        Description copied from class: DataDefinitionSeg
        Return the number of bytes occupied by a single instance of the given data type. When the data is indirect, size is zero. When the data is variable length, size is -1;
        Specified by:
        getSizeImpl in class DataDefinitionSeg
        Returns:
        Number of bytes.

      • minSize

        public int minSize​(DataContext ctx)
        Description copied from class: DataDefinitionSeg
        Some data types need to offer a range of sizes for the encoded form of their data. The common case is fixed.
        Overrides:
        minSize in class DataDefinitionSeg
        Returns:

      • maxSize

        public int maxSize​(DataContext ctx)
        Description copied from class: DataDefinitionSeg
        Some data types need to offer a range of sizes for the encoded form of their data. The common case is fixed.
        Overrides:
        maxSize in class DataDefinitionSeg
        Returns:

      • alignment

        public int alignment​(DataContext ctx)
        Description copied from class: DataDefinitionSeg
        Alignment is normally the natural size of a primitive element. Structured types and variable length types must override this method.
        Overrides:
        alignment in class DataDefinitionSeg
        Returns:

      • construct

        protected BaseDataType<?> construct​(int[] dimensions,
                                    DataContext ctx)
        Description copied from class: DataDefinitionSeg
        Construct an instance of the type represented by this definition, using the given dimensions. This is an implementation detail that permits a DecoratedDefSeg to create arrays.

        Use the provided context to look up any ambiguous data types.

        Specified by:
        construct in class DataDefinitionSeg
        Returns:

      • simpleString

        public java.lang.String simpleString()
        Description copied from class: PathSegment
        Supply s simple descriptive name usable when browsing a hierarchy. A simple type name for elementary types, a non-detailed description for complex types.
        Specified by:
        simpleString in class PathSegment
        Returns:

      • set

        public PathSegment set​(java.nio.ByteBuffer source,
                       boolean padded)
        Description copied from class: PathSegment
        Replace the current instance content with the decoded source bytes.

        The caller must ensure that the instance is appropriate for the bytes supplied. This permits instance re-use in optimized applications.

        Specified by:
        set in class PathSegment
        Parameters:
        source - The bytes to be decoded. The position will be left after the last byte of the decoded segment.
        padded - Alternate format selection. Packed format when false.
        Returns:
        The same instance.

      • put

        public void put​(java.nio.ByteBuffer dest,
                boolean padded)
        Description copied from class: PathSegment
        Encode the current instance to the given destination.
        Specified by:
        put in class PathSegment
        Parameters:
        dest - The buffer receiving the complete encoded instance.
        padded - Alternate format selection. Packed format when false.

      • getBytes

        public int getBytes()
        Description copied from class: PathSegment
        Obtain the number of bytes needed to encode this segment instance in packed format.
        Specified by:
        getBytes in class PathSegment
        Returns:
        Number of bytes, assuming put() will be called with padded false.

      • getTokens

        public java.util.List<java.lang.String> getTokens()
        Specified by:
        getTokens in class PathSegment