org.vishia.inspcPC.mng

Class InspcFieldOfStruct

java.lang.Object

org.vishia.inspcPC.mng.InspcFieldOfStruct

public class InspcFieldOfStruct
extends java.lang.Object

This class contains all data which describes a field formally used or not used for access yet. If the field should be used for access the var should be gotten respectively created. A field is created as answer of 'cmdGetFields' from a target. In that time the field is not accessed already, only its name and type is known. Only this information are stored here. A field can be created for a known type of struct without access to the target too. A field is more lightweight than a variable.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	hasSubstruct
java.lang.String	identifier
(package private) static java.util.Map<java.lang.String,java.lang.String>	idxPrimitiveTypes
java.lang.String	nameShow
int	nrofArrayElements
InspcStruct	struct
java.lang.String	type
(package private) InspcVariable	var Maybe null if the field was not read until now.

Constructor Summary

Constructors

Constructor and Description
InspcFieldOfStruct(InspcStruct parent, java.lang.String nameShow, java.lang.String identifier, java.lang.String type, int nrofArrayElements, boolean hasSubstruct) Creates a field in a given parent struct.
InspcFieldOfStruct(InspcVariable var, java.lang.String type, int nrofArrayElements, boolean hasSubstruct) Creates a field for a given variable.

Method Summary

Modifier and Type	Method and Description
InspcVariable	variable(InspcVariable parent, VariableContainer_ifc container) Returns the variable which is assigned to the given field.
InspcVariable	variableExisting() Returns the existing variable, do not create a new one, returns null if this field has not a variable yet.
(package private) boolean	XXXhasSubstruct()

Methods inherited from class java.lang.Object

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

Field Detail

struct

public final InspcStruct struct

nameShow

public final java.lang.String nameShow

identifier

public final java.lang.String identifier

type

public final java.lang.String type

hasSubstruct

public final boolean hasSubstruct

nrofArrayElements

public final int nrofArrayElements

var

InspcVariable var

Maybe null if the field was not read until now. Not all fields creates variables.

idxPrimitiveTypes

static java.util.Map<java.lang.String,java.lang.String> idxPrimitiveTypes

Constructor Detail

InspcFieldOfStruct

public InspcFieldOfStruct(InspcStruct parent,
                          java.lang.String nameShow,
                          java.lang.String identifier,
                          java.lang.String type,
                          int nrofArrayElements,
                          boolean hasSubstruct)

Creates a field in a given parent struct. This ctor is used after response to 'getFields' or if the name of fields are known, especially for standard types.

Parameters:

parent - The struct which contains this field.

nameShow - The name to show in the table.

identifier - The name to use for creating a variable.

type - The type to show in table.

nrofArrayElements - >0 then it is an array type.

hasSubstruct - true then it describes a variable which is a struct. The InspcStruct instance of this field which contains the sub fields will be referenced if an variable was created with var. InspcVariable.itsStruct.

InspcFieldOfStruct

public InspcFieldOfStruct(InspcVariable var,
                          java.lang.String type,
                          int nrofArrayElements,
                          boolean hasSubstruct)

Creates a field for a given variable. This ctor is used if a field is necessary where a variable is given. TODO store the one time created field in the variable if the variable exists already.

Parameters:

var -

type - The type to show in table.

nrofArrayElements - >0 then it is an array type.

hasSubstruct - true then it describes a variable which is a struct. The InspcStruct instance of this field which contains the sub fields will be referenced if an variable was created with var. InspcVariable.itsStruct.

Method Detail

XXXhasSubstruct

boolean XXXhasSubstruct()

variable

public InspcVariable variable(InspcVariable parent,
                              VariableContainer_ifc container)

Returns the variable which is assigned to the given field. If the field has not a variable then the variable will be created with the path of the parent (struct) variable and the name of the field. The concept is: create variable only if they are necessary. It is possible to view a structure but don't have variable for all fields. This method creates the variable if it is necessary.

Parameters:

param - the variable of the structure, same as InspcStruct.varOfStruct.

container - the container where all variables can be gotten with given path. It is the InspcMng

Returns:

The variable associated to the field which allows communication with the target.

variableExisting

public InspcVariable variableExisting()

Returns the existing variable, do not create a new one, returns null if this field has not a variable yet.