class MessageDefinition
Package: swiss.avm.up.core.generic.specification.interface_local.javamodel.MessageDefinition
Direct Known Subclasses:
class MessageDefinition extends NamedResource, AbstractMessageDefinition, MessageProperties, APrefixedResource
Definition of a message
Properties
ackType
How a message has to be confirmed.
ModelTypeValue[0..1]
ackWhileActiveAllowed
Message can be acknowledged while still active
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
cluster
Cluster that is affected by the message.
AControllerLocalAccessibleCluster[0..1]
cluster
Cluster that is affected by the message.
AControllerLocalAccessibleCluster[0..1]
comment
Describes the intent of this Resource.
TextLiteral[0..1]
A Literal that accepts multiple lines of text.
description
Complete description of the message. This is normally used as help text on the HMI. Concatenation of multiple descriptions supported.
ATextSource[0..N]
fullNameElement
Contains an element of the full name of the message. Is generally used for the display on the HMI.
All name elements are combined to form the full name
ATextSource[0..N]
id
controller unique message id
IntegerLiteral[1..1]
A literal which accepts 32-bit integral number values.
level
Level of the message.
AbstractMessageLevel[0..1]
level
AbstractMessageLevel[0..1]
log
Message is logged by the logging system
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
name
The name of this Resource.
StringLiteral[1..1]
prio
The priority may be used by the hmi for sorting
IntegerLiteral[0..1]
A literal which accepts 32-bit integral number values.
publish
Enables the notification for HMI listeners
BooleanLiteral[0..1]
A literal where only the two values 'false' and 'true' are accepted.
reaction
AbstractMessageReaction[0..N]
reactions
Reaction of the message.
AbstractMessageReaction[0..N]
textSource
Contains the full name of the message. Normally used for display on the HMI.
ATextSource[0..N]
type
Type of message
ModelTypeValue[0..1]
Method Summary
getAllMessageDefinitionOverrides
@InterfaceLocalFunctionspace
Return:
List<MessageDefinitionOverride>
getAllMessageDefinitions
@InterfaceLocalFunctionspace
Return:
List<MessageDefinition>
getClusterId
@MessageFunctions
Final cluster of the message, taking all overrides into account.
Parameters:
ControllerInstanceWrapper
Return:
IntegerLiteral
getComment
@FComments
getConstantName
@MessageFunctions
Parameters:
ACallingBaseElement
getMaxId
@InterfaceLocalFunctionspace
Return:
IntegerLiteral
getMessageWrapperLiteral
@MessageFunctions
Parameters:
ControllerInstanceWrapper
ControllerTree
Return:
MessageWrapperLiteral
getUniqueMessageIndex
@TemplateFunction
Parameters:
ControllerInstanceWrapper
ControllerTree
Return:
IntegerLiteral
indexOf
@MessageFunctions
Parameters:
Controller
Return:
IntegerLiteral
internal_getRealMessageOverride
@ConfigFunctionSpace
Parameters:
ControllerInstanceArrayIndex
BaseInstanceConfig
Return:
List<MessageDefinitionOverride>