Package com.automation_pros.odva.cip.path

Class NamedStructSeg

  • All Implemented Interfaces:
    java.lang.Comparable<PathSegment>
    public class NamedStructSeg
extends StructDefSeg
    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

      • size

        protected int size

      • CRC

        protected java.lang.Integer CRC

      • typeName

        protected java.lang.String typeName

    • Constructor Detail

      • NamedStructSeg

        protected NamedStructSeg()

      • NamedStructSeg

        public NamedStructSeg​(java.lang.String typeName)

    • Method Detail

      • setTypeName

        public void setTypeName​(java.lang.String typeName)
        Specified by:
        setTypeName in class StructDefSeg

      • 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:

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class PathSegment

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • 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.

      • makeNameSeg

        protected SymbolSeg makeNameSeg()

      • 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