childMethods
AbstractChild."method"
getACommand
Returns current Acommand of child controller
USAGE:
child.getACommand()
RETURN:
command: COMMAND (UINT)
RETURN TYPE:
UINT
Return:
UINT
getControllerId
Gets controller id of child controller
USAGE:
child.getControllerId()
RETURN
ControllerId: UINT
RETURN TYPE:
UINT
Return:
UINT
getMCommand
Returns current Mcommand of child controller
USAGE:
child.getMCommand()
RETURN:
command: COMMAND (UINT)
RETURN TYPE:
UINT
Return:
UINT
getMessageCounter
Message counter for user defined message types
Usage:
// get counter of a controller
child.getMessageCounter(userType, uinCounter);
INPUT:
userType : MessageType [1:1]
uinCounter : UINT [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
userType : MessageType
uinCounter : UINT
getMode
Gets mode of child controller
USAGE:
child.getMode();
RETURN:
mode: USINT
RETURN TYPE:
USINT
Return:
USINT
getState
USAGE:
child.getState();
INPUT:
RETURN:
state: STATE (UINT)
RETURN TYPE:
UINT
Return:
UINT
getTopState
USAGE:
child.getTopState();
INPUT:
RETURN:
topState: STATE (UINT)
RETURN TYPE:
UINT
Return:
UINT
reset
Sets reset to child controller
USAGE:
child.reset();
RETURN TYPE:
VOID
Return:
VOID
resetAll
Sets reset to child controller. The reset signal is also propagated to all child controllers underneath.
USAGE:
child.resetAll();
RETURN TYPE:
VOID
Return:
VOID
resetCommand
Resets commands on child controller
USAGE:
child.resetCommand()
INPUT
RETURN TYPE:
VOID
Return:
VOID
setCommand
Sets command to child controller
USAGE:
child.setCommand(command);
INPUT:
command: COMMAND (UINT)
INPUT:
command [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
command
setMCommand
Sets manual command to child controller
USAGE:
child.setMCommand(command);
INPUT:
command: COMMAND (UINT)
INPUT:
command [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
command
setMode
Sets mode to child controller
USAGE:
child.setMode(mode);
INPUT:
mode: MODE (USINT)
INPUT:
mode : USINT [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
mode : USINT
setModeAll
Sets modeAll to child controller
USAGE:
child.setModeAll(mode);
INPUT:
mode: MODE (USINT)
INPUT:
mode : USINT [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
mode : USINT
setSimulation
Sets simulation to child controller
USAGE:
child.simulation(simulation);
INPUT:
simulation: BOOL
INPUT:
simulation : BOOL [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
simulation : BOOL
setSimulationAll
Sets simulation to child controller. The simulation flag is also propagated to all child controllers underneath.
Attention: Method simply operates Interface Strkutur and this reacts to the flank change.
USAGE:
child.simulationAll(simulation);
INPUT:
simulation: BOOL
INPUT:
simulation : BOOL [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
simulation : BOOL
ControllerInterface."method"
getMode
Returns TRUE if all child controller with given controller interface have the requested mode
USAGE:
controllerInterface.getMode(mode);
RETURN:
mode: MODE
INPUT:
mode : USINT [1:1]
RETURN TYPE:
BOOL
Return:
BOOL
Parameters:
mode : USINT
getState
Returns TRUE if all child controller with given controller interface have reached the requested state
Optionally, with exceptChild, children can be specified for which the stat should not be checked.
USAGE:
controllerInterface.getState(state);
controllerInterface.getState(state, exceptChild);
INPUT:
state: STATE (UINT)
exceptChild: CHILD
RETURN:
BOOL
INPUT:
state : UINT [1:1]
exceptChild [0:n]
RETURN TYPE:
BOOL
Return:
BOOL
Parameters:
state : UINT
exceptChild
getTopState
Returns TRUE if all child controller with given controller interface have reached the requested topState
Optionally, with exceptChild, children can be specified for which the stat should not be checked.
USAGE:
controllerInterface.getTopState(topState);
controllerInterface.getTopState(topState, exceptChild);
INPUT:
state: STATE (UINT)
exceptChild: CHILD
RETURN:
BOOL
INPUT:
state : UINT [1:1]
exceptChild [0:n]
RETURN TYPE:
BOOL
Return:
BOOL
Parameters:
state : UINT
exceptChild
setCommand
Sets command to all child controller with the given controller interface
Optionally, with exceptChild, children can be specified for which the command should not be set.
USAGE:
controllerInterface.setCommand(command);
controllerInterface.setCommand(command, exceptChild);
INPUT:
command: COMMAND (UINT)
exceptChild: CHILD
INPUT:
command : UINT [1:1]
exceptChild [0:n]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
command : UINT
exceptChild
setMode
Sets mode to all child controller with the given controller interface
USAGE:
controllerInterface.setMode(mode);
INPUT:
mode: MODE
INPUT:
mode : USINT [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
mode : USINT
setModeAll
Sets modeAll to all child controller with the given controller interface
USAGE:
controllerInterface.setModeAll(mode);
INPUT:
mode: MODE
INPUT:
mode [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
mode
setSimulation
Sets simulation to all child controller with the given controller interface
USAGE:
controllerInterface.setSimulation(simulation);
INPUT:
simulation: BOOL
INPUT:
simulation : BOOL [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
simulation : BOOL
setSimulationAll
Sets simulation to all child controller with the given controller interface
USAGE:
controllerInterface.setSimulation(simulation);
INPUT:
simulation: BOOL
INPUT:
simulation : BOOL [1:1]
RETURN TYPE:
VOID
Return:
VOID
Parameters:
simulation : BOOL