Package com.automation_pros.odva.cip.path

Class PortSeg

java.lang.Object

com.automation_pros.odva.cip.path.PathSegment

com.automation_pros.odva.cip.path.PortSeg

All Implemented Interfaces:

java.lang.Comparable<PathSegment>

public class PortSeg
extends PathSegment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PortSeg.Decoder	Decode bytes expected to contain one encoded path segment.
static class	PortSeg.Parser	A port segment consumes two tokens: the device port (not internet port number) and the address.
static class	PortSeg.SlotParser	A port segment with port #1 is reserved for backplanes.

Nested classes/interfaces inherited from class com.automation_pros.odva.cip.path.PathSegment

PathSegment.HasAlternateHex

Field Summary

Fields

Modifier and Type	Field	Description
protected byte[]	address
static int	ENIP_CLASS1_PORT
static int	ENIP_CLASS3_PORT
protected short	port
static byte	SEGTYPE
static java.util.Map<java.lang.Short,PortSeg>	slotCache

Fields inherited from class com.automation_pros.odva.cip.path.PathSegment

identifierChars, segtype

Constructor Summary

Constructors

Modifier	Constructor	Description
	PortSeg()
	PortSeg(short port, byte[] addr)
protected	PortSeg(short port, short slot)
	PortSeg(short port, java.net.InetAddress addr)
	PortSeg(short port, java.net.InetSocketAddress addr)

Method Summary

Modifier and Type	Method	Description
int	compareTo(PathSegment o)
byte[]	getAddress()
int	getBytes()	Obtain the number of bytes needed to encode this segment instance in packed format.
static PortSeg	getCached(short port, short addr)
short	getPort()
short	getSlot()
java.net.InetSocketAddress	getSocketAddress()
java.util.List<java.lang.String>	getTokens()
int	hashCode()
void	put(java.nio.ByteBuffer dest, boolean padded)	Encode the current instance to the given destination.
PathSegment	set(java.nio.ByteBuffer source, boolean padded)	Replace the current instance content with the decoded source bytes.
void	setAddress(byte[] address)
void	setAddress(java.lang.String address)
void	setAddress(java.net.InetAddress address)
void	setAddress(java.net.InetSocketAddress address)
void	setPort(short port)
java.lang.String	simpleString()	Supply s simple descriptive name usable when browsing a hierarchy.

Methods inherited from class com.automation_pros.odva.cip.path.PathSegment

decode, decodeAll, equals, getSegtype, getWords, hexString, mergeTokens, registerHandler, setSegtype, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEGTYPE

public static final byte SEGTYPE

See Also:

Constant Field Values

slotCache

public static final java.util.Map<java.lang.Short,PortSeg> slotCache

ENIP_CLASS1_PORT

public static final int ENIP_CLASS1_PORT

See Also:

Constant Field Values

ENIP_CLASS3_PORT

public static final int ENIP_CLASS3_PORT

See Also:

Constant Field Values

port

protected short port

address

protected byte[] address

Constructor Detail

PortSeg

public PortSeg()

PortSeg

protected PortSeg(short port,
                  short slot)

PortSeg

public PortSeg(short port,
               byte[] addr)

PortSeg

public PortSeg(short port,
               java.net.InetSocketAddress addr)

PortSeg

public PortSeg(short port,
               java.net.InetAddress addr)

Method Detail

getCached

public static PortSeg getCached(short port,
                                short addr)

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.

getPort

public short getPort()

setPort

public void setPort(short port)

getAddress

public byte[] getAddress()

getSlot

public short getSlot()

getSocketAddress

public java.net.InetSocketAddress getSocketAddress()

setAddress

public void setAddress(byte[] address)

setAddress

public void setAddress(java.lang.String address)

setAddress

public void setAddress(java.net.InetAddress address)

setAddress

public void setAddress(java.net.InetSocketAddress address)

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.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(PathSegment o)

Specified by:

compareTo in interface java.lang.Comparable<PathSegment>

Overrides:

compareTo in class PathSegment

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:

getTokens

public java.util.List<java.lang.String> getTokens()

Specified by:

getTokens in class PathSegment