class MessageProperties
Package: swiss.avm.up.core.generic.specification.interface_local.javamodel.MessageProperties
Direct Known Subclasses: MessageDefinition, MessageDefinitionOverride
class MessageProperties extends ATextSourceProperty
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]
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]
level
Level of the message.
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.
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.
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
getMessageDefinitionOverride
@ControllerInstanceWrapperFunctionSpace
Parameters:
ControllerInstanceWrapper
BaseInstanceConfig
Return:
MessageDefinitionOverride
getTextLists
@TextFunctionSpace
Returns all controller message text lists and if override, text list defined there too.
Return:
List<NativeTextList>
internal_getGlobalLevels
@InterfaceLocalFunctionspace
Return:
List<MessageGlobalLevel>
internal_getGlobalReactions
@InterfaceLocalFunctionspace
Return:
List<MessageGlobalReaction>
internal_getReactions
@MessageTemplateFunction
Return:
StringLiteral