class ControllerTree
Package: swiss.avm.up.core.generic.instantiation.javamodel.ControllerTree
Direct Known Subclasses:
class ControllerTree extends BaseControllerTree, ACallingBaseElement
The ControllerTree is the central element of a UP application. It is used to divide a machine process into functional units, so-called Controller. The tree defines a hierarchy in which the higher-level controllers communicate with the lower-level controllers. Communication takes place via the controller interface. The subordinate controllers (child) are commanded by the higher-level controllers (parent). The ControllerTree exists in a project only once.
Properties
comment
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
datatypeLibrary
DatatypeLibrary[0..N]
diagram
ControllerTreeDiagram[0..N]
globalVariableLibrary
GlobalVariableLibrary[0..N]
level
Level[1..N]
The hierarchy of the ControllerTree is defined by levels. The number of levels used is not limited. Within the levels the controller is instantiated.
The usual levels are defined as follows:
Level 4, Top Level:
MAIN controllers and "general services" like HMI, Filehandler, ... which have nothing to do with the control function.
Level 3, Group:
Group controller, strongly machine-related, head of an entire function group.
Level 2, module:
Modules which perform a corresponding function in a group can also be instantiated several times within group or within a whole machine.
Level 1, Element group:
Smallest group of similarities, summary of simple element controllers, which do not necessarily have to be addressed separately.
Level 0, Element:
Lowest level of the controller, fulfills exactly one task, reusable, interface to the hardware.
Driver, Driver:
Hardware-specific configuration, interface between element controller and hardware (typical application for controllers with motion tasks -> controller is identical, drivers differ depending on the drive used).
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
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