childIteratorMethods

ChildIterator."method"

getACmd

USAGE:
childIterator.getACmd();

RETURN:
command: COMMAND (UINT)

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

getExist

USAGE:
childIterator.getExist(childIndex);

INPUT:
childIndex : USINT

RETURN:
exist: BOOL

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
BOOL

Return:

BOOL

Parameters:

childIndex : USINT

getId

USAGE:
childIterator.getId(childIndex);

INPUT:
childIndex : USINT

RETURN:
instance: UINT

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

getMCmd

USAGE:
childIterator.getMCmd();

RETURN:
command: COMMAND (UINT)

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

getMode

USAGE:
childIterator.getExist(childIndex);

INPUT:
childIndex : USINT

RETURN:
mode: MODE (UINT)

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

getMsgCtr

Message counter for user defined message types

Usage:
// get counter of a controller
childIterator.getMsgCtr(childIndex, usertype);

INPUT:
childIndex : USINT
usertype: MessagType

RETURN:
counter: UINT

INPUT:
childIndex : USINT [1:1]
usertype : MessageType [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT
usertype : MessageType

getSim

USAGE:
childIterator.getSimulation(childIndex);

INPUT:
childIndex : USINT

RETURN:
simulation: BOOL

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
BOOL

Return:

BOOL

Parameters:

childIndex : USINT

getState

USAGE:
childIterator.getState(childIndex);

INPUT:
childIndex : USINT

RETURN:
state: STATE (UINT)

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

getTopState

USAGE:
childIterator.getTopState(childIndex);

INPUT:
childIndex : USINT
UINT
RETURN:
state: STATE (UINT)

INPUT:
childIndex : USINT [1:1]

RETURN TYPE:
UINT

Return:

UINT

Parameters:

childIndex : USINT

indexOf

Get index of child

Usage:
childIterator.indexOf(child)
childIterator.indexOf(controllerId)

INPUT:
child : UINT [1:1]

RETURN TYPE:
USINT

Return:

USINT

Parameters:

child : UINT

setCmd

USAGE:
child.setCmd(childIndex, command);

INPUT:
childIndex : USINT
command: COMMAND (UINT)

INPUT:
childIndex : USINT [1:1]
command [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

childIndex : USINT
command

setExist

USAGE:
child.setExist(childIndex, exist);

INPUT:
childIndex : USINT
exist: BOOL

INPUT:
childIndex : USINT [1:1]
exist : BOOL [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

childIndex : USINT
exist : BOOL

setForEach

Set value for each child

Usage:
childIterator.setForEach(childIterator.variable, value)

INPUT:
variable : TYPE_ANY [1:1]
value : TYPE_ANY [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

variable : TYPE_ANY
value : TYPE_ANY

setMode

USAGE:
child.setMode(childIndex, mode);

INPUT:
childIndex : USINT
command: MODE (UINT)

INPUT:
childIndex : USINT [1:1]
mode : USINT [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

childIndex : USINT
mode : USINT

size

Get number of children

Usage:
childIterator.size()

RETURN TYPE:
UINT

Return:

UINT

stateLog

Activate and deactivate the statelog functionality.

USAGE:
child.stateLog(childIndex, enable);

INPUT:
childIndex : USINT
enable: BOOL

INPUT:
childIndex : USINT [1:1]
enable : BOOL [1:1]

RETURN TYPE:
VOID

Return:

VOID

Parameters:

childIndex : USINT
enable : BOOL