Skip to content

class ControllerInstance

Package: swiss.avm.up.core.generic.instantiation.controller_instance.javamodel.ControllerInstance

Direct Known Subclasses:


class ControllerInstance extends AnnotableComment, RangeChildFieldRef, BaseTreeElementInstance

A ControllerInstance is a Controller placed in the ControllerTree under a Level. It represents one concrete occurrence of a controller type, carrying its instance-specific attributes and the wiring to its child instances.

Properties

alias_name

Alias for messagehandling - for a better understanding of the message instead of instance name

TextLiteral[0..1]

A Literal that accepts multiple lines of text.

childInstance

Relation to the child controller instance.

ChildInstance[1..1]

A ChildInstance binds a parent's Child slot to a concrete child
ControllerInstance in the tree. It is the instance-level half of the
parent-child relationship and completes the type-level Child slot.

comment

Describes the intent of this Resource.

TextLiteral[0..1]

A Literal that accepts multiple lines of text.

id

Unique ID for all controller instances within the ControllerTree.

IntegerLiteral[0..1]

A literal which accepts 32-bit integral number values.

indexDomain

Defines the controller that has the array definition of a controller array.

IndexDomain[0..1]

instanceNr

Unique ID over all instances of a controller within the ControllerTree.

IntegerLiteral[1..1]

A literal which accepts 32-bit integral number values.

instanceOf

Type of this ControllerInstance

Controller[1..1]

A Controller is a reusable control-behaviour type - the unit that defines the
commands, states, transitions, interlocks and messages for one kind of device or
function. It is instantiated many times as ControllerInstances in the tree and
exposes its behaviour through a public interface, a per-instance interface and a
private internal interface. A project controller usually extends a library base
controller and adds only its specific behaviour.

userTaskLinkInstance

Relation zu einem UserTask.

UserObjectLinkInstance[1..1]

A UserObjectLinkInstance is the instance-level binding on a ControllerInstance
that connects the controller's UserObjectLink to a placed UserObjectWrapper,
wiring this instance to the tree-global blackboard.

Method Summary

diagram_ToolTipFigure

@FigureFunctionSpace

diagram_arraName

@FigureFunctionSpace

diagram_baseId

@FigureFunctionSpace

diagram_baseNr

@FigureFunctionSpace

diagram_figureExtendetNameSingleInstance

@FigureFunctionSpace

diagram_getArrayIndexSize

@FigureFunctionSpace

Parameters:

IntegerLiteral

Return:

IntegerLiteral

diagram_getArrayIndexes

@FigureFunctionSpace

Parameters:

IntegerLiteral

Return:

List<IntegerLiteral>

diagram_getDimensionIndexes

@FigureFunctionSpace

Return:

List<IntegerLiteral>

diagram_getDimensionSize

@FigureFunctionSpace

Get dimension size of the ControllerInstance.
Default size = 1.

Return:

IntegerLiteral

diagram_isArray

@FigureFunctionSpace

Return:

BooleanLiteral

diagram_isArrayAndAliasAvailable

@FigureFunctionSpace

returns true
if the controller instance is an array and alias name is set

Return:

BooleanLiteral

diagram_isArrayAndNotSamePackage

@FigureFunctionSpace

returns true
if the controller instance is a array and
the controllerinstance and the controller contains not in the same package.

Return:

BooleanLiteral

diagram_isArrayAndSamePackage

@FigureFunctionSpace

returns true
if the controller instance is a array and
the controllerinstance and the controller contains in the same package.

Return:

BooleanLiteral

diagram_isNotArrayAndAliasAvailable

@FigureFunctionSpace

returns true
if the controller instance is not an array and alias name is set

Return:

BooleanLiteral

diagram_isNotArrayAndNotSamePackage

@FigureFunctionSpace

returns true
if the controller instance is a not array and
the controllerinstance and the controller contains in the same package.

Return:

BooleanLiteral

diagram_isNotArrayAndSamePackage

@FigureFunctionSpace

returns true
if the controller instance is a not array and
the controllerinstance and the controller contains in the same package.

Return:

BooleanLiteral

extendetName

@TemplateNameFunctions

Parameters:

IntegerLiteral

getInstanceNames

@FControllerInstance

getName

@Functionspace

indexOf

Parameters:

Level

Return:

IntegerLiteral

internal_getClusterPath

@ControllerFunctionSpace

Return:

List<ClusterInstance>

internal_getParentControllerInstance

@ControllerTreeFunctionSpace

Return:

ControllerInstance

internal_iterationMasterControllerInstances

@ControllerInstanceWrapperFunctionSpace

get all Master controllerInstance from the ControllerInstance

Return:

List<ControllerInstance>

model_getAllControllerInstanceSameInstanceOf

@ControllerFunctionSpace

Return:

List<ControllerInstance>

model_getAllSlaveTreeElementInstance

@ControllerFunctionSpace

get All slave controllerInstances from the ControllerInstance

Return:

List<BaseTreeElementInstance>

model_getAllUserTask

@ControllerFunctionSpace

Return:

List<AUserObject>

model_getChildBaseTreeElementInstancesUnique

@ControllerFunctionSpace

Return:

List<BaseTreeElementInstance>

model_getChildControllerInstances

@ControllerFunctionSpace

Return:

List<BaseTreeElementInstance>

model_hasChildInstance

@ControllerFunctionSpace

Return:

BooleanLiteral