Package com.automation_pros.odva.cip.data

Class StructDefCtx

java.lang.Object

com.automation_pros.odva.cip.data.StructDefCtx

All Implemented Interfaces:

DataContext

public class StructDefCtx
extends java.lang.Object
implements DataContext

Field Summary

Fields inherited from interface com.automation_pros.odva.cip.data.DataContext

emptyContext

Constructor Summary

Constructors

Constructor	Description
StructDefCtx()

Method Summary

Modifier and Type	Method	Description
void	clear()
BaseDataType<?>	getCtxDataImpl(java.util.List<PathSegment> reference)	Look up reference data within this current context for use in indirection of various kinds, as described for getCtxData(), which uses this implementation and handles delegation to outer contexts.
AnonStructSeg	getNamedDef(java.lang.String name)	Look up a named type for use expanding a stub definition or to apply to a different context.
java.util.List<java.lang.String>	getNames()
DataContext	getParentDataCtx()	Get the next outer DataContext from the current context.
java.lang.String	getTypeByCRC(int crc)	Look up a named type by CRC for use directly by a StructureDefSeg or indirectly by an AnonTypeSeg.
StructDef	getTypeByName(java.lang.String typeName)	Look up a named type for use constructing nested elements of a structure.
java.util.ArrayList<StructDef>	getTypesImpl()
void	registerNamedDef(java.lang.String name, StructDef sd)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.automation_pros.odva.cip.data.DataContext

fromEnum, getCtxData, getCtxDataOrNull, getTypes, makeHosted, makeUnhosted, toEnum

Constructor Detail

StructDefCtx

public StructDefCtx()

Method Detail

clear

public void clear()

registerNamedDef

public void registerNamedDef(java.lang.String name,
                             StructDef sd)

getNamedDef

public AnonStructSeg getNamedDef(java.lang.String name)

Description copied from interface: DataContext

Look up a named type for use expanding a stub definition or to apply to a different context.

Specified by:

getNamedDef in interface DataContext

getTypeByName

public StructDef getTypeByName(java.lang.String typeName)

Description copied from interface: DataContext

Look up a named type for use constructing nested elements of a structure.

Specified by:

getTypeByName in interface DataContext

Parameters:

typeName - The type name to look up in the predefined names.

Returns:

The type suitable for use with CipStruct and/or StructMember.

getTypesImpl

public java.util.ArrayList<StructDef> getTypesImpl()

Specified by:

getTypesImpl in interface DataContext

getNames

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

getTypeByCRC

public java.lang.String getTypeByCRC(int crc)

Description copied from interface: DataContext

Look up a named type by CRC for use directly by a StructureDefSeg or indirectly by an AnonTypeSeg.

Specified by:

getTypeByCRC in interface DataContext

Returns:

The type suitable for use with CipStruct and/or StructMember.

getParentDataCtx

public DataContext getParentDataCtx()

Description copied from interface: DataContext

Get the next outer DataContext from the current context.

Specified by:

getParentDataCtx in interface DataContext

Returns:

The containing DataContext, or null if the current context is the root context.

getCtxDataImpl

public BaseDataType<?> getCtxDataImpl(java.util.List<PathSegment> reference)

Description copied from interface: DataContext

Look up reference data within this current context for use in indirection of various kinds, as described for getCtxData(), which uses this implementation and handles delegation to outer contexts.

Specified by:

getCtxDataImpl in interface DataContext

Parameters:

reference - The path to a data item.

Returns:

A data object