Skip to content

messageMethods

AMessageCluster."method"

ack

Acknowledge message or messages

Usage:
acknowledge messages of global cluster
CLUSTER.ack();

RETURN TYPE:
VOID

Return:

VOID

getCounters

Message system counter for standard message types

Usage:
// get counter of system
msgGlb.getCounters(uinError, uinWarning, uinInfo, uinMaintenance);

INPUT:
uinError : UINT [1:1]
uinWarning : UINT [1:1]
uinInfo : UINT [1:1]
uinMaintenance : UINT [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

uinError : UINT
uinWarning : UINT
uinInfo : UINT
uinMaintenance : UINT

getLevel

Actual message level

Usage:
CLUSTER.getLevel();

RETURN TYPE:
UDINT

Return:

UDINT

getReaction

Test a cluster on a single reaction

Usage:
getReaction(CLUSTER.REACTION);
getReaction(0x000F);

INPUT:
reaction [1:1]

RETURN TYPE:
BOOL

Return:

BOOL

Parameters:

reaction

getReactions

Active reactions of a cluster

Usage:
udiReactions = CLUSTER.getReactions();

RETURN TYPE:
UDINT

Return:

UDINT

getSpecCounter

Message system counter for user defined message types

Usage:
// get counter of a cluster
msgGlb.getSpecCounter(USERTYPE);
return UINT uinCounter

INPUT:
userType : MessageType [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

userType : MessageType

getSpecCounter_deprecated

Message system counter for user defined message types

Usage:
// get counter of a cluster
msgGlb.getSysSpecCounter(USERTYPE, uinCounter);

INPUT:
userType : MessageType [1:1]
uinCounter : UINT [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

userType : MessageType
uinCounter : UINT

msgTest_Reset

Reset of reactions and levels on a message cluster.

This function is mainly intended for the test framework and not for productive use.

Usage:
CLUSTER.msgSetReaction(CLUSTER, CLUSTER.LEVEL);
CLUSTER.msgSetReaction(CLUSTER, 0x000F);

RETURN TYPE:
UINT

Return:

UINT

msgTest_SetLevel

Set a level on a message cluster.

This function is mainly intended for the test framework and not for productive use.
Get cluster level method at UPact does not see that this level was set. It only sees the level from messages. However at the target system it does.

Usage:
CLUSTER.msgTest_SetLevel(CLUSTER.LEVEL);
CLUSTER.msgTest_SetLevel(0x000F);

INPUT:
level : TYPE_ANY [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

level : TYPE_ANY

msgTest_SetReaction

Set a raction on a message cluster.

This function is mainly intended for the test framework and not for productive use.

Usage:
CLUSTER.msgTest_SetReaction(CLUSTER.REACTION);
CLUSTER.msgTest_SetReaction(0x000F);

INPUT:
reaction : TYPE_ANY [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

reaction : TYPE_ANY

MessageDefinition."method"

ack

Acknowledge message

Usage:
acknowledge message of actual controller
MESSAGE.ack();

RETURN TYPE:
VOID

Return:

VOID

getAckState

Acknowledge state of a message

USAGE:
MESSAGE.getAckState()

RETURN TYPE:
AcknowledgeState

Return:

AcknowledgeState

getHandle

get unique handle of current message

RETURN TYPE:
UDINT

Return:

UDINT

getState

State of a message

USAGE:
MESSAGE.getState();

RETURN TYPE:
MessageState

Return:

MessageState

reset

Reset message

Usage:
MESSAGE.reset();

RETURN TYPE:
VOID

Return:

VOID

set

Set message

Usage:
MESSAGE.set();
MESSAGE.set('info');

INPUT:
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

info : STRING

setCondition

Set and reset message by condition

Usage:
MESSAGE.condition(bolCondition);
MESSAGE.condition(bolCondition ,'info');

INPUT:
bolCondition : BOOL [1:1]
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

bolCondition : BOOL
info : STRING

setReset

Set and reset of a message in one cycle.
Only executed if msg is acknowledged.

Usage:
MESSAGE.setReset();
MESSAGE.setReset('info');

INPUT:
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

info : STRING

setReset_deprecated

Set and reset of a message in one cycle

Usage:
MESSAGE.setReset();
MESSAGE.setReset('info');

INPUT:
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

info : STRING

msg."method"

ack

Acknowledge message by handle

Usage:
// acknowledge message of actual controller
msg.ack(handle);

INPUT:
handle : UDINT [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT

getAckState

Acknowledge state of a message by handle

USAGE:
msg.getAckState(handle);

INPUT:
handle : UDINT [1:1]

RETURN TYPE:
AcknowledgeState

Return:

AcknowledgeState

Parameters:

handle : UDINT

getState

State of a message by handle

USAGE:
msg.getState(handle);

INPUT:
handle : UDINT [1:1]

RETURN TYPE:
MessageState

Return:

MessageState

Parameters:

handle : UDINT

reset

Reset message by handle

Usage:
msg.reset(handle);

INPUT:
handle : UDINT [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT

set

Set message by handle

Usage:
msg.set(handle);
msg.set(handle,'info');

INPUT:
handle : UDINT [1:1]
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT
info : STRING

setCondition

Set and reset message by condition and handle

Usage:
msg.condition(handle,bolCondition);
msg.condition(handle,bolCondition ,'info');

INPUT:
handle : UDINT [1:1]
bolCondition : BOOL [1:1]
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT
bolCondition : BOOL
info : STRING

setReset

Set and reset of a message by handle in one cycle.
Only executed if msg is acknowledged.

Usage:
msg.setReset(handle);
msg.setReset(handle, 'info');

INPUT:
handle : UDINT [1:1]
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT
info : STRING

setReset_deprecated

Set and reset of a message by handle in one cycle

Usage:
msg.setReset(handle);
msg.setReset(handle, 'info');

INPUT:
handle : UDINT [1:1]
info : STRING [0:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

handle : UDINT
info : STRING