class BaseControllerTree
Package: swiss.avm.up.core.generic.instantiation.javamodel.BaseControllerTree
Direct Known Subclasses: Cluster, ControllerTree
abstract class BaseControllerTree extends NamedResource, DatatypeLibraryOwner
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
getAllAbstractUserObject
@ControllerTreeFunctionSpace
Return:
List<AUserObject>
getAllAbstractUserObjectSorted
@ControllerTreeFunctionSpace
Return:
List<AUserObject>
getAllCommands_Unique
@StatemachineTemplateFunctions
Return:
List<Command>
getAllControllerInstanceWrappers
@ControllerInstanceWrapperFunctionSpace
Return:
List<ControllerInstanceWrapper>
getAllControllerInstanceWrappersSorted
@ControllerInstanceWrapperFunctionSpace
Return:
List<ControllerInstanceWrapper>
getAllControllerInstanceWrappersSortedById
@ControllerInstanceWrapperFunctionSpace
Return:
List<ControllerInstanceWrapper>
getAllControllerInterface
@ControllerTreeFunctionSpace
Return:
List<ControllerInterface>
getAllControllerInterfaceUnique
@ControllerTreeFunctionSpace
Returns all used controller interface from all controller in the controller tree.
Return:
List<ControllerInterface>
getAllControllerInterfaceUniqueInstantiated
@ControllerTreeFunctionSpace
Returns all used controller interface from all controller in the controller tree.
Return:
List<ControllerInterface>
getAllControllerUnique
@ControllerTreeFunctionSpace
Get all the instantiated controler types including the supertypes
Return:
List<Controller>
getAllControllerUniqueInstantiated
@ControllerTreeFunctionSpace
Get only the instantiated controller types without the supertypes
Return:
List<Controller>
getAllDatatypeLibrariesUniqueSorted
Parameters:
Model
Return:
List<DatatypeLibrary>
getAllHistorySuperStates_Unique
@StatemachineTemplateFunctions
Return:
List<StateWrapper>
getAllInOutControllerInstanceWrapper
@InterlockWrapperFunctionSpace
get list of all controllerInstanceWrapper used in one of the interlock instances
Return:
List<ControllerInstanceWrapper>
getAllIntercomControllerInstance
@ControllerTreeFunctionSpace
Return:
List<ControllerInstance>
getAllIntercomTask
@ControllerTreeFunctionSpace
Return:
List<IntercomTask>
getAllIntercomWrappers
@IntercomWrapperFunctionSpace
Return:
List<IntercomWrapper>
getAllInterlockInstances
@ControllerTreeFunctionSpace
Return:
List<InterlockInstance>
getAllInterlockInstances
Return:
List<InterlockInstance>
getAllInterlockInstances
Return:
List<InterlockInstance>
getAllInterlockInstances
Return:
List<InterlockInstance>
getAllInterlockWrappers
@InterlockWrapperFunctionSpace
Return:
List<InterlockWrapper>
getAllOutputInterlockControllerInstance
@ControllerTreeFunctionSpace
Return:
List<ControllerInstance>
getAllOutputInterlockControllerInstanceUnique
@ControllerTreeFunctionSpace
Return:
List<ControllerInstance>
getAllStatesCommandsUniqueCount
@StatemachineTemplateFunctions
count of all states and commands
Return:
IntegerLiteral
getAllStatesCommands_Unique
@StatemachineTemplateFunctions
Return:
List<NamedResource>
getAllStates_Unique
@StatemachineTemplateFunctions
Return:
List<StateWrapper>
getAllUsedCommands
@ControllerTreeFunctionSpace
Return:
List<Command>
getAllUsedCommands_Unique
@ControllerTreeFunctionSpace
Return:
List<Command>
getAllUsedCommands_UniqueSorted
@ControllerTreeFunctionSpace
Return:
List<Command>
getAllUserObject
@ControllerTreeFunctionSpace
Return:
List<UserObject>
getAllUserObjectWrapper
@ControllerTreeFunctionSpace
Return:
List<UserObjectWrapper>
getAllVariableLibraries
@ControllerTreeFunctionSpace
Return:
List<AVariableLibrary>
getAnalogInput
Parameters:
PlatformType
getAnalogOutput
Parameters:
PlatformType
getCommandCount
@StatemachineTemplateFunctions
get number of defined commands
Return:
IntegerLiteral
getDatatypeLibraries
@FDatatypeLibrary
Returns a recursive non-cyclic list of all datatype libraries. Starting from the current controller tree.
Parameters:
Model
Return:
List<DatatypeLibrary>
getDigitalInput
getDigitalOutput
getHistorySuperStatesIndex
@StatemachineTemplateFunctions
Parameters:
StateWrapper
Return:
IntegerLiteral
getMaxChildControllerCount
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getMaxChildControllerCountArraySize
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getMaxChildControllerCountArraySizeNull
@ControllerTreeFunctionSpace
Return:
BooleanLiteral
getMaxCommandControllerCount
@ControllerTreeFunctionSpace
Get max amount of commands in a controller within the controller tree.
Return:
IntegerLiteral
getMaxCommandId
@StatemachineTemplateFunctions
Return:
IntegerLiteral
getMaxCommandIdAsArray
@StatemachineTemplateFunctions
Return:
List<IntegerLiteral>
getMaxControllerIdValue
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getMaxControllerIdValueArray
@ControllerTreeFunctionSpace
Return:
List<IntegerLiteral>
getMaxControllerInstanceId
@InstantiationFunctions
Return:
IntegerLiteral
getMaxHierarchicalStateLevelCount
@StatemachineTemplateFunctions
returns the maximum depth of hierarchical state levels of the whole controller tree
Return:
IntegerLiteral
getMaxHistoryCount
@StatemachineTemplateFunctions
Return:
IntegerLiteral
getMaxStateCommandId
@StatemachineTemplateFunctions
Return:
IntegerLiteral
getMaxStateCommandsIdAsArray
@StatemachineTemplateFunctions
Return:
List<IntegerLiteral>
getMaxTransitionStateSequenceCount
@StatemachineTemplateFunctions
max. number of state sequences in a transition (maximum hierarchical state levels * 2)
Return:
IntegerLiteral
getMaxUserTaskLinkCount
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getNumberOfMessages
@MessageTemplateFunction
Return:
IntegerLiteral
getNumberOfMessagesMaxIndex
@MessageTemplateFunction
Return:
IntegerLiteral
getPlatformDatatypeLibraries
@FDatatypeLibrary
Returns only the platform-dependent libraries
Parameters:
PlatformType
Return:
List<PlatformDatatypeLibrary>
getPlatformSpecificDatatypeLibraries
@FDatatypeLibrary
Provides all libraries necessary for the given platform
Parameters:
PlatformType
Model
Return:
List<DatatypeLibrary>
getStatesCommandsIndex
@StatemachineTemplateFunctions
Parameters:
AState
Return:
IntegerLiteral
htmlHeader
@PCD_Documentation
internal_getAllDatatypeLibrariesWoExt
@FDatatypeLibrary
Get all datatype libraries but without any possible extensions
Parameters:
Model
Return:
List<DatatypeLibrary>
internal_getAllDatatypeLibrarys
@FDatatypeLibrary
Parameters:
Model
Return:
List<DatatypeLibrary>
internal_getAllVariableLibraries
@ControllerTreeFunctionSpace
Return:
List<AVariableLibrary>
model_getContainedBaseControllerTrees
@ControllerTreeFunctionSpace
Return:
List<BaseControllerTree>
model_getRootControllerInstance
@ControllerInstanceWrapperFunctionSpace
Return:
ControllerInstance
model_getTopLevel
@ControllerInstanceWrapperFunctionSpace
Return:
Level