Package com.automation_pros.odva.cip.path
Implementations of segment selectors encoding and decoding,
including data type definition segments, per ODVA's CIP
Specification, Volume 1, Appendix C, § C-1, § C-6, and § C-4.2.
Also includes vendor-specific extensions and variations as needed to support communications with Allen-Bradley ControlLogix™/CompactLogix™ and Omron NJ/NX processors.
All supported segment encoding/decoding operations are implementations
of the abstract class PathSegment.
Collections of segments into hierarchical selectors and complex
data type definitions, plus parsing of human-readable forms of
these segments is incorporated into
CipPath.
Run-time traversal of object trees and any contained data items
using suitable segment selectors is implemented in
DataResolver.
Parsable composition of CipPaths and a variety of common arithmetic
and logical operations, with efficient runtime execution, is
implemented in
CipExpression.
-
Interface Summary Interface Description PathSegment.HasAlternateHex Mark implementations that have nested elements that can have their hex representations shown separately.PathSegmentDecoder PathTokenParser SymbolSeg TypeTokenParser -
Class Summary Class Description AbbrevStructSeg Encapsulates an elementary data type annotation within a CIP Path definition.AbbrevStructSeg.Decoder Decode bytes expected to contain one encoded path segment.AliasDefSeg AliasDefSeg.Decoder Decode bytes expected to contain one encoded path segment.AliasDefSeg.Parser AnonStructSeg Encapsulates an elementary data type annotation within a CIP Path definition.AnonStructSeg.Decoder Decode bytes expected to contain one encoded path segment.AnsiSymbolSeg AnsiSymbolSeg.Decoder Decode bytes expected to contain one encoded path segment.AnsiSymbolSeg.Parser An ANSI symbol segment can have any ISO-8859-1 characters.ArrayIndexSeg ArrayIndexSeg.Decoder Decode bytes expected to contain one encoded path segment.ArrayIndirectSeg ArrayIndirectSeg.Decoder Decode bytes expected to contain one encoded path segment.AttributeSeg AttributeSeg.Decoder Decode bytes expected to contain one encoded path segment.BitIndexSeg BitIndexSeg.Decoder Decode bytes expected to contain one encoded path segment.BitIndirectSeg BitIndirectSeg.Decoder Decode bytes expected to contain one encoded path segment.CipExpression Support expressions composed of variables, constants, and common operators, where variables are parsable CipPaths, and operators are applied in postfix (aka Reverse Polish Notation) order.CipExpression.AddOp CipExpression.AndOp CipExpression.BinaryOp CipExpression.BitwiseOp CipExpression.CompareOp CipExpression.Constant CipExpression.DivideOp CipExpression.InvertOp CipExpression.LogicalAndOp CipExpression.LogicalOrOp CipExpression.MathOp CipExpression.ModulusOp CipExpression.MultiplyOp CipExpression.NotOp CipExpression.OrOp CipExpression.SubtractOp CipExpression.TrinaryOp CipExpression.UnaryOp CipExpression.Variable CipExpression.XorOp CipPath An ordered list ofPath Segmentsto be used as a locator for CIP objects, data elements, and/or network nodes in the various services in the CIP specification.CipPath.CompositeParser A parser factory for keywords that call multiple other parsers to produces a segment list.CipPath.StaticParser A parser factory for keywords that will simply return a constant path segment.CipPath.StaticTypeParser A parser factory for keywords that will return a constant data definition segment.ClassSeg ClassSeg.Decoder Decode bytes expected to contain one encoded path segment.ConstructedDefSeg Encapsulates an elementary data type annotation within a CIP Path definition.ConstructedDefSeg.Decoder Decode bytes expected to contain one encoded path segment.ConstructedDefSeg.Parser ConxPtSeg ConxPtSeg.Decoder Decode bytes expected to contain one encoded path segment.DataDefinitionSeg DataDefinitionSeg.DataDefinitionFragment DecoratedDefSeg Implements array dimensions for both standalone types and structure members, plus names for the latter.DecoratedDefSeg.Decoder Decode bytes expected to contain one encoded path segment.EKeySeg EKeySeg.Decoder Decode bytes expected to contain one encoded path segment.EKeySeg.Parser This parser is expected to registered for the 'ekey' keyword.ElementarySeg Encapsulates an elementary data type annotation within a CIP Path definition.ElementarySeg.Decoder Decode bytes expected to contain one encoded path segment.ExtLogSeg ExtLogSeg.Decoder Decode bytes expected to contain one encoded path segment.FixedTagSeg FixedTagSeg.Decoder Decode bytes expected to contain one encoded path segment.FixedTagSeg.Parser This parser is expected to registered for the 'ftag' and 'fixedtag' keywords.HostedBitDefSeg Encapsulates an elementary data type annotation within a CIP Path definition.HostedBitDefSeg.Decoder Decode bytes expected to contain one encoded path segment.HostedBitDefSeg.Parser InhibitSeg InhibitSeg.Decoder Decode bytes expected to contain one encoded path segment.InhibitSeg.Parser This parser is expected to registered for the 'inh' and 'inhibit' keywords.InstanceSeg InstanceSeg.Decoder Decode bytes expected to contain one encoded path segment.LogicalSeg LogicalSeg.LogicalParser An attribute segment must have a ID number that fits in an unsigned word.MemberHandleSeg Structure member selector by handle.MemberHandleSeg.Decoder Decode bytes expected to contain one encoded path segment.MemberNumSeg Structure member selector by 1-based element number.MemberNumSeg.Decoder Decode bytes expected to contain one encoded path segment.MemberSeg MemberSeg.Decoder Decode bytes expected to contain one encoded path segment.MemberSeg.Parser An member segment may have any 32-bit ID number.NamedStructSeg Encapsulates an elementary data type annotation within a CIP Path definition.NamedStructSeg.Decoder Decode bytes expected to contain one encoded path segment.NestedLogicalSeg NestedLogicalSeg.SubscriptParser NetworkSeg OmStringDefSeg Encapsulates an elementary data type annotation within a CIP Path definition.OmStringDefSeg.Decoder Decode bytes expected to contain one encoded path segment.OmStringDefSeg.Parser Registered as "omstring".PathSegment In CIP, "Segments" encode various pieces of information that are then used to locate objects within a device's internal address space.PortSeg PortSeg.Decoder Decode bytes expected to contain one encoded path segment.PortSeg.Parser A port segment consumes two tokens: the device port (not internet port number) and the address.PortSeg.SlotParser A port segment with port #1 is reserved for backplanes.ScheduleSeg ScheduleSeg.Decoder Decode bytes expected to contain one encoded path segment.ScheduleSeg.Parser This parser is expected to registered for the 'sched' and 'schedule' keywords.ServiceSeg ServiceSeg.Decoder Decode bytes expected to contain one encoded path segment.SimpleDataSeg SimpleDataSeg.Decoder Decode bytes expected to contain one encoded path segment.SimpleDataSeg.Parser This parser is expected to registered for the 'data' keyword.StructDefSeg StructDefSeg.Parser Parse after the keyword "Struct" to obtain either an abbreviated structure segment (numeric CRC code) or a named structure segment (anything other identifier).SymbolicSeg SymbolicSeg.Decoder Decode bytes expected to contain one encoded path segment.SymbolicSeg.Parser A symbolic segment is not restricted to ISO-8859-1 characters.