class ControllerTree
Package: swiss.avm.up.core.generic.instantiation.javamodel.ControllerTree
Direct Known Subclasses:
class ControllerTree extends BaseControllerTree, ACallingBaseElement
The ControllerTree is the root of a project's instantiation hierarchy. It owns the chain of Levels and through them all controller instances, plus the project's datatype-library links. There is exactly one per project.
Properties
comment
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
datatypeLibrary
DatatypeLibrary[0..N]
A DatatypeLibrary holds the datatypes and constants used by a project and its
controllers - enumerations, record types, function-block types and named
constants. Controller interface and local variables are typed by its contents; a
master library aggregates per-controller sub-libraries.
diagram
ControllerTreeDiagram[0..N]
globalVariableLibrary
GlobalVariableLibrary[0..N]
level
Level[1..N]
A Level is a node in the ControllerTree hierarchy. It holds controller instances
and chains to a parent level, and can also host cross-cutting content such as
placed user objects and interlock instances. Dedicated levels are often used for
concerns like communication or interlocks.
name
The name of this Resource.
StringLiteral[1..1]
Method Summary
createOpcUaCommonIf
@BrControllerTreeFunctionSpace
Parameters:
Model
BR_Config
Return:
OpcUaNodeLiteral
createOpcUaFileVersion3
Parameters:
Model
Config
BR_Config
createOpcUaWithXmlTree
Parameters:
Model
Build
BR_Config
Config
HardwareConfig
createOpcUaWithXmlTreeFileVersion10
Parameters:
Model
Build
BR_Config
Config
HardwareConfig
getAllFunctionBlockModelDefinition
@TemplateFunction
returns all functions blocks which are modeled in a library
Parameters:
Model
Return:
List<FunctionBlockModel>
getAllMessageWrapperLiteral
@MessageFunctions
Return:
List<MessageWrapperLiteral>
getAllMessages
@MessageFunctions
Return:
List<MessageDefinition>
getControllerInstanceWrapperOfInstanceGroup
@ControllerInstanceWrapperFunctionSpace
Parameters:
InstanceGroup
Return:
List<ControllerInstanceWrapper>
getControllerInstanceWrapperSubList
@ControllerTreeFunctionSpace
Parameters:
Build
Return:
List<ControllerInstanceWrapper>
getControllerInstanceWrappers
@FControllerTree
Returns all controller instances that are used in the ControllerTree.
Return:
List<ControllerInstanceWrapper>
getControllerSubList
@ControllerTreeFunctionSpace
Parameters:
Build
Return:
List<Controller>
getControllerUniqueOfInstanceGroup
@ControllerTreeFunctionSpace
Parameters:
InstanceGroup
Return:
List<Controller>
getDefaultAndPlatformLibraries
@FTemplateFunctions
Returns a list of libraries (Default libraries and Plattform dependent libraries)
Parameters:
PlatformType
Return:
List<AVariableLibrary>
getDependencies
Parameters:
Model
Return:
List<StringLiteral>
getInOutTypesUnique
@FTemplateFunctions
Result is sorted, AETyp order changes otherwise.
Return:
List<Type>
getInputsOutputsJson
Return:
StringLiteral
getJson
Parameters:
Model
Return:
StringLiteral
getJson
Parameters:
Model
TestTargetConfig
SuiteInstance
Return:
StringLiteral
getMaxControllerIdx
@ControllerTreeFunctionSpace
The controller index is a sequential number that is determined automatically.
Return:
IntegerLiteral
getMaxInstanceNameNativeLength
@ControllerTreeFunctionSpace
Returns length of longest native instance name of all controllers.
Return:
IntegerLiteral
getMaxNumberOfUsedInstanceableCluster
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getMaxNumberOfUsedInstanceableClusterIdx
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getMessageCollection
@MessageFunctions
Return:
MessageCollectionLiteral
getMessageStartIndex
@TemplateFunction
Returns a combined index of controllerinstancewrappers and message
Parameters:
ControllerInstanceWrapper
Return:
IntegerLiteral
getPackagesContainingController
@TemplateFunction
returns a list of all packages containing controller
Return:
List<StringLiteral>
getPlatformVariableLibrariesNonExtended
@VariableFunctionSpace
Return:
List<PlatformVariableLibrary>
getRangeDefinition
Parameters:
BR_Config
Return:
StringLiteral
getRootControllerInstanceWrapper
@ControllerInstanceWrapperFunctionSpace
Return:
ControllerInstanceWrapper
getRootLevel
@ControllerTreeFunctionSpace
Return:
Level
getStatefullComponentElementMaxId
@AnimationFunctions
Return:
IntegerLiteral
getStatefullComponentMaxNumberOfElements
@AnimationFunctions
Max number of elements of SC
Return:
IntegerLiteral
getStatefullComponentMeanNumberOfElements
@AnimationFunctions
Mean number of elements of SC
Return:
IntegerLiteral
getStatefullComponentMeanNumberOfSCInstances
@AnimationFunctions
Mean number of instances of a SC type
Return:
IntegerLiteral
getStatefullComponentNumberOfSC
@AnimationFunctions
Total number of SC
Return:
IntegerLiteral
getStatefullComponentStateMaxId
@AnimationFunctions
Return:
IntegerLiteral
getStatefullComponentTransitionMaxId
@AnimationFunctions
Return:
IntegerLiteral
getSubPackagesContainingController
@TemplateFunction
Parameters:
StringLiteral
Return:
List<StringLiteral>
getTreeJson
Parameters:
Build
Return:
StringLiteral
getUserObjectWrapperOfInstanceGroup
@ControllerInstanceWrapperFunctionSpace
Parameters:
InstanceGroup
Return:
List<UserObjectWrapper>
getWscNumberOfBufferElements
Return:
IntegerLiteral
setDefaultToGlobalVariables
@FDefaultValues
Parameters:
PlatformType