class ControllerInterface
Package: swiss.avm.up.core.generic.specification.interface_declaration.javamodel.ControllerInterface
Direct Known Subclasses:
class ControllerInterface extends NamedResource, AnnotableComment, DatatypeLibraryOwner
Definition of public informations of a [Controller]. A Controller interface can implement other interfaces and inherits all its elements.
Properties
command
Known commands of the controller.
Command[0..N]
Commands are typically used to trigger transitions between states. Each controller has a command interface through which actions can be triggered on the controller.
Commands are defined globally. However, a controller only knows the commands to which it should respond.
The parent-child relationship in the controller tree automatically establishes a command channel for top-down commands.
comment
Describes the intent of this Resource.
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
data
Public data value.
AInterfaceData[0..N]
This abstract interface data class is only used for backward compatibility of deprecated Recipe, Parameter, Current, Config classes. It will be removed in future.
datatypeLibrary
DatatypeLibrary[0..N]
implements
Selection of all interfaces from which to be inherited.
ControllerInterface[0..N]
Definition of public informations of a [Controller].
A Controller interface can implement other interfaces and inherits all its elements.
inputOutput
Input and output variables, which are connected to corresponding hardware.
InputOutput[0..N]
Input and output variables ensure the connection to the real hardware. In the specific hardware configuration, these signals are mapped to inputs and outputs.
name
The name of this Resource.
StringLiteral[1..1]
passThroughParameter
Input and output variable that is part of a controller interface and serves as a formal pass-through parameter.
PassThroughParameter[0..N]
Input and output variable that is part of a controller interface and serves as a formal pass-through parameter.
state
each controller which implements this interface must have a state with the same name
IfaceState[0..N]
Method Summary
className
@TemplateNameFunctions
Structure name at PLC
diagram_getAllControllerInterface
@FigureFunctionSpace
Return:
List<ControllerInterface>
getAllData
@FControllerInterface
Returns all interface data elements of a controller interface and all its implemented interfaces.
Return:
List<AInterfaceData>
getAllDataWithDataGroup
@ControllerFunctionSpace
Parameters:
CustomDataGroup
Return:
List<AInterfaceData>
getCommands
@ControllerFunctionSpace
Returns all commands with inheritance tree and distinct filter.
Return:
List<Command>
getControllerCommandIndex
@TemplateFunction
Parameters:
Command
Return:
IntegerLiteral
getControllerInterfaceDefinition_S7Tia
getControllerWithDefinedInterface
@ControllerTreeFunctionSpace
Return:
List<ControllerInstance>
getControllerWithDefinedInterfaceArraySize
@ControllerTreeFunctionSpace
Return:
IntegerLiteral
getDataGroupUnique
@ControllerFunctionSpace
Returns a list of all data group who are used at controller interface at least once.
Return:
List<CustomDataGroup>
getDataRecordTypesUnique
@ServiceUiFunctions
Returns at data and IO's used RecordType structures unique. Consider that unsupported records filtered (filterUnsupportedItems).
Return:
List<AStructureType>
getDataRemanent
@FTemplateFunctions
Returns list of interface data who are part of remanent handler.
Return:
List<AInterfaceData>
getImplementedInterfaces
@LibraryFunctionSpace
Return:
List<ControllerInterface>
getInputsOutputs
@FControllerInterface
Returns all inputs and outputs of a controller interface and all its implemented interfaces.
Return:
List<InputOutput>
getPassThroughParameters
@FControllerInterface
Return:
List<PassThroughParameter>
getStates
@ControllerFunctionSpace
get all states defined in the interface and of all implemented interfaces with distinct filter.
Return:
List<IfaceState>
hasRemanentGroup
@FControllerInterface
Return:
BooleanLiteral
ifClassName
@TemplateNameFunctions
Structure name at PLC
ifsClassName
@TemplateNameFunctions
Structure name at PLC
ifsRemClassName
@TemplateNameFunctions
Structure name at PLC
internal_getAllInterfaceData
@ControllerFunctionSpace
Returns all interfaceData of all implemented controllerInterfaces (including extended elements)
Return:
List<InterfaceData>
internal_getDataGroupList
@ControllerFunctionSpace
Internal function is used to group (dataGroup) as list
Return:
List<CustomDataGroup>
internal_getDatatypeLibraries
@FDatatypeLibrary
Return:
List<DatatypeLibrary>
ioClassName
@TemplateNameFunctions
Structure name at PLC