[[TracNav(WARPLab7/TOC)]]

= Trigger Manager Commands Technical Reference =

Trigger Manager commands are selected as string inputs to the {{{wl_triggerManagerCmd}}} method in [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_node.m wl_node.m]. These strings are each individual cases of the switch statement in {{{procCmd}}} method of [browser:/ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_trigger_manager.m wl_trigger_manager.m].

== Syntax == 
MATLAB allows two valid forms of syntax for calling methods

 * Let {{{N}}} be a scalar or vector of {{{wl_node}}} objects
 * Let {{{command_string}}} be a string containing a particular command
 * Let {{{arg}}} be an argument for that command (optional)

Syntax 1: {{{wl_triggerManagerCmd(N, command_string, arg1, arg2, ..., argN)}}}

Syntax 2: {{{N.wl_triggerManagerCmd(command_string, arg1, arg2, ..., argN)}}}

These two different forms of syntax are identical and either may be used for issuing commands to WARP nodes.


== Command List and Documentation == 
=== {{{add_trigger_input}}} ===
Associates node to a trigger input[[BR]]


'''Arguments:''' (wl_trigger_manager TRIGGER)

'''Returns:''' none


=== {{{delete_trigger_input}}} ===
Deassociates node to a trigger input[[BR]]


'''Arguments:''' (wl_trigger_manager TRIGGER)

'''Returns:''' none


=== {{{clear_trigger_input}}} ===
Clears all trigger associations in the node[[BR]]


'''Arguments:''' none

'''Returns:''' none


=== {{{get_trigger_input}}} ===
Reads current trigger association from node[[BR]]


'''Arguments:''' node

'''Returns:''' (uint32 TRIGGER_ASSOCIATION)
TRIGGER_ASSOCIATION: bit-wise AND of associated[[BR]]
trigger IDs[[BR]]


=== {{{test_trigger}}} ===
Sends a test trigger[[BR]]


'''Arguments:''' none

'''Returns:''' none