Package com.automation_pros.odva.logix

Class LgxProbeReport.LgxProbedTag

java.lang.Object

com.automation_pros.odva.logix.LgxProbeReport.LgxNamedData

com.automation_pros.odva.logix.LgxProbeReport.LgxProbedTag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LgxProbeReport.LgxProbedTag>

Enclosing class:

LgxProbeReport

public static class LgxProbeReport.LgxProbedTag
extends LgxProbeReport.LgxNamedData
implements java.lang.Comparable<LgxProbeReport.LgxProbedTag>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
int	dataAddress
int[]	dimensions
int	elementSize
int	instance
protected java.lang.String	name
java.lang.String	program
boolean	readOnly
boolean	safety
int	symbAddress
protected int	symbType
protected LgxProbeReport.LgxProbedType	tpltype

Constructor Summary

Constructors

Constructor	Description
LgxProbedTag(int instance, java.lang.String name, int symbType)
LgxProbedTag(java.lang.String program, int instance, java.lang.String name, int symbType)

Method Summary

Modifier and Type	Method	Description
int	bitAddress()	Used to determine aliasing.
LgxProbeReport.LgxProbedTag	clone()
int	compareTo(LgxProbeReport.LgxProbedTag o)
protected java.lang.String	fullName()
int[]	getDimensions()	Obtain the sizes of each array dimension, if any, outermost first.
java.lang.String	getName()	Obtain the tag or member name for use in an ANSI Symbol segment.
int	getSymbolType()	A Logix symbol type code is a 16-bit word signals the number of array dimensions and distinguishes a structure type from a base type.
LgxProbeReport.LgxProbedType	getType()	When a Logix symbol is a complex type, and the probe algorithm has enumerated it, return the probe object.
void	setType(LgxProbeReport.LgxProbedType pt)
java.lang.String	toString()
int	typeSize()

Methods inherited from class com.automation_pros.odva.logix.LgxProbeReport.LgxNamedData

abbrevTypeDef, decoratedTypeDef, dimDisplay, getStructId, namedTypeDef, totalBits, totalBytes, typeName

Methods inherited from class java.lang.Object

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

Field Detail

program

public final java.lang.String program

instance

public final int instance

name

protected final java.lang.String name

symbType

protected final int symbType

dimensions

public int[] dimensions

dataAddress

public int dataAddress

symbAddress

public int symbAddress

elementSize

public int elementSize

safety

public boolean safety

readOnly

public boolean readOnly

tpltype

protected transient LgxProbeReport.LgxProbedType tpltype

Constructor Detail

LgxProbedTag

public LgxProbedTag(int instance,
                    java.lang.String name,
                    int symbType)

LgxProbedTag

public LgxProbedTag(java.lang.String program,
                    int instance,
                    java.lang.String name,
                    int symbType)

Method Detail

clone

public LgxProbeReport.LgxProbedTag clone()

Overrides:

clone in class java.lang.Object

getName

public java.lang.String getName()

Description copied from class: LgxProbeReport.LgxNamedData

Obtain the tag or member name for use in an ANSI Symbol segment.

Specified by:

getName in class LgxProbeReport.LgxNamedData

Returns:

Tag or Member name string.

getSymbolType

public int getSymbolType()

Description copied from class: LgxProbeReport.LgxNamedData

A Logix symbol type code is a 16-bit word signals the number of array dimensions and distinguishes a structure type from a base type. This is only used in Rockwell processors during browse.

Specified by:

getSymbolType in class LgxProbeReport.LgxNamedData

Returns:

A 16-bit encoded type, as follows: Bit 15: 0 for base type, 1 for structure type Bits 14-13: Array shape (number of dimensions). Bit 12: System reserved flag. Included in structure id. Bits 12-0: Structure Identifier for structure types. Bits 7-0: CIP Formal Type for base types.

getType

public LgxProbeReport.LgxProbedType getType()

Description copied from class: LgxProbeReport.LgxNamedData

When a Logix symbol is a complex type, and the probe algorithm has enumerated it, return the probe object. Must be assigned, typically after the fact in LgxProbeReport.reMap().

Specified by:

getType in class LgxProbeReport.LgxNamedData

Returns:

setType

public void setType(LgxProbeReport.LgxProbedType pt)

bitAddress

public int bitAddress()

Used to determine aliasing.

Returns:

typeSize

public int typeSize()

Overrides:

typeSize in class LgxProbeReport.LgxNamedData

getDimensions

public int[] getDimensions()

Description copied from class: LgxProbeReport.LgxNamedData

Obtain the sizes of each array dimension, if any, outermost first. Structure members can only have one dimension in Logix.

Specified by:

getDimensions in class LgxProbeReport.LgxNamedData

Returns:

An integer array. Length zero if not an array.

compareTo

public int compareTo(LgxProbeReport.LgxProbedTag o)

Specified by:

compareTo in interface java.lang.Comparable<LgxProbeReport.LgxProbedTag>

fullName

protected java.lang.String fullName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object