| Customize Help
| Save Settings

MsysIoCommandRegister


Function Map
Syntax
Description
Parameters
- IoCmdListSysId
- Operation
Table: For specifying the command to register
+ combination: For automatically adding operations to the I/O command list
- Reference
Table: For specifying the reference timestamp
- DelayFromReference
- Duration
- BitToOperate
Table: For specifying the bit of the I/O command register to operate
- CommandStatusPtr
Table: For returning the status of the command registration
Return value
Compilation information
Synopsis
Add a command to change the state of a bit of the I/O command register at a specified time or counter value.
Syntax
MIL_INT MsysIoCommandRegister(
MIL_ID IoCmdListSysId, //in
MIL_INT64 Operation, //in
MIL_INT64 Reference, //in
MIL_DOUBLE DelayFromReference, //in
MIL_DOUBLE Duration, //in
MIL_INT64 BitToOperate, //in
void *CommandStatusPtr //out
)
Description

This function adds (registers) a command to the I/O command list to change the state of a specified bit of the I/O command register at a specified moment (time or counter value). To route the state of an I/O command register bit to an output signal, use MsysControl() with M_IO_SOURCE before you change the state of the bit.

When adding a command, you must specify when it must be executed. If the command list was allocated using MsysIoAlloc() with M_CLOCK, specify the time at which to execute the command in seconds after a specified reference time; otherwise, specify it in number of counter increments after a specified reference counter value. For example, if you want to execute a command 50 msecs after the moment MsysIoCommandRegister() is called, you would specify M_REFERENCE_VALUE_CURRENT as the reference time and 0.05 seconds as the amount of time after this reference time to execute the command.

When adding a command to change an I/O command register bit such that a pulse is generated on the associated signal, two commands are actually added; one command to transition the signal at the specified moment and one command to transition the signal back to its original state after the specified pulse duration. Note that if you want to specify the duration of the pulse in seconds, but MsysIoAlloc() with M_CLOCK is not set as the counter source, use a timer to generate the pulse and the I/O command list to trigger the timer (generation of the pulse); schedule an M_IMPULSE command instead and use the affected I/O command register bit as the trigger source of the timer.

Multiple commands can be scheduled to execute at the same time or counter value, as long as the commands are affecting different I/O command register bits. If a command has been registered with the I/O command list to affect a specific I/O command register bit, and you attempt to add a different command to affect the same bit at the same specified time or counter value, the original command will be overwritten.

[Matrox 4Sight GP/GPm]

On a Matrox 4Sight GPm computer, this function is only available if a MIL Host system was previously allocated. It is not available on a Matrox 4Sight GP.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.
Parameters
This function is not supported on the selected boards.
This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.
Parameters
IoCmdListSysId

Specifies the identifier of the I/O command list in which to add a command.

Operation

Specifies the command to add to the I/O command list to change the state of the specified I/O command register bit. This parameter can be set to one of the following values:

function map For specifying the command to register
Click to summarizeValue Description MIL system-specific
tooltip (‡)
Click to summarize M_EDGE_FALLING +

Specifies that the command will change the specified bit such that the associated signal will transition from high to low, if it is high.

 ‡ a t
U28		 w
U53		 z
Click to summarize M_EDGE_RISING +

Specifies that the command will change the specified bit such that the associated signal will transition from low to high, if it is low.

 ‡ a t
U28		 w
U53		 z
Click to summarize M_IMPULSE +

Specifies the command will change the specified bit such that the associated signal will produce the shortest possible active-high pulse on the specified I/O command list bit. An active-high pulse is a low-to-high signal transition followed by a high-to-low signal transition. Unlike M_PULSE_HIGH, the Duration parameter must be set to M_DEFAULT and a single command producing the shortest possible pulse is generated. This operation should not be output to external devices since it might be filtered out as noise. It can, however, be used to trigger internal hardware devices, such as timers.

(summarize)
‡ a t
U28		 w
U53		 z
Click to summarize M_NONE +

Specifies no operation is performed. This operation can be used to cancel a command previously added to the I/O command list.

(summarize)
‡ a t
U28		 w
U53		 z
Click to summarize M_PULSE_HIGH +

Specifies to add two commands to the I/O command list, an M_EDGE_RISING and an M_EDGE_FALLING command, to change the specified bit such that the associated signal will produce an active-high pulse. An active-high pulse is a low-to-high signal transition followed by a high-to-low signal transition; specify the length of the pulse using the Duration parameter. Note that if the signal is already high, it will remain high for the specified duration and then transition to low (unless a command is added to transition it to low earlier).

(summarize)
‡ a t
U28		 w
U53		 z
Click to summarize M_PULSE_LOW +

Specifies to add two commands to the I/O command list, an M_EDGE_FALLING and an M_EDGE_RISING command, to change the specified bit such that the associated signal will produce an active-low pulse. An active-low pulse is a high-to-low signal transition followed by a low-to-high signal transition; specify the length of the pulse using the Duration parameter. Note that if the signal is already low, it will remain low for the specified duration and then transition to high (unless a command is added to transition it to high earlier).

(summarize)
‡ a t
U28		 w
U53		 z
Combination values for the values listed in For specifying the command to register.

You can add one of the following values to the above-mentioned values to specify that the operation will be automatically added to the I/O command list upon the change of an I/O command register.

function map For automatically adding operations to the I/O command list
Click to summarizeCombination value Description MIL system-specific
tooltip (‡)
Click to summarize M_AUTO_REGISTER

Specifies to automatically add the specified command to the I/O command list every time the latch used as a reference ( M_LATCHn) is triggered.

(summarize)
‡ a t
U28		 w
U53		 z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 51 (or later) is installed. It is not available on a Matrox 4Sight GP.

 ‡ a
Click to summarize M_AUTO_REGISTER_CANCEL

Specifies to stop automatically adding the specified command to the I/O command list every time the latch used as a reference ( M_LATCHn) is triggered.

(summarize)
‡ a t
U28		 w
U53		 z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

On a Matrox 4Sight GPm platform, this value is only available if MIL 10 update 51 (or later) is installed. It is not available on a Matrox 4Sight GP.

 ‡ a
Reference

Specifies the reference time or counter value to which the delay is added. This parameter can be set to one of the following values:

function map For specifying the reference timestamp
Click to summarizeValue Description MIL system-specific
tooltip (‡)
Click to summarize M_LATCHn

Specifies to schedule the operation relative to the current value of reference latch n, where n is a number from 1 to 4.

Note that M_LATCHn must be used with either M_AUTO_REGISTER or M_AUTO_REGISTER_CANCEL.

(summarize)
‡ a t
U28		 w
U53		 z
MIL system specific
[This is only applicable to Matrox 4Sight GP/GPm platform]

This is only available on Matrox 4Sight GPm, where n is a number from 1 to 4.

 ‡ a

For the Matrox Iris GTR, n can be a value from 1 to 2.

 ‡ t
U28

For the Matrox Concord PoE, n can be a value from 1 to 4.

 ‡ z

For the Matrox Concord Indio, n can be a value from 1 to 4.

 ‡ w
U53
Click to summarize M_REFERENCE_VALUE_CURRENT

Specifies to schedule the command relative to the current moment (that is, the moment MsysIoCommandRegister() is called).

 ‡ a t
U28		 w
U53		 z
Click to summarize Value

Specifies the time or counter value relative to which to schedule the command. This is typically a previously inquired time or counter value. You can inquire the time or counter value at a specific moment during the execution of your program using MsysIoInquire() with M_REFERENCE_VALUE. Additionally, if using a latch that has previously saved the time or counter value upon a hardware event, you can inquire this using MsysIoInquire() with M_REFERENCE_LATCH_VALUE or within the scope of a system hook-handler function using MsysGetHookInfo() with M_REFERENCE_LATCH_VALUE.

(summarize)
‡ a t
U28		 w
U53		 z
DelayFromReference

Specifies the delay to add to the reference time or counter value; the sum of the two establishes the specific moment that the command is executed. If the I/O command list was allocated using MsysIoAlloc() with M_CLOCK as the counter source, specify the delay in seconds. Otherwise, specify it in number of counter increments.

Note that, if the command list was allocated for an M_CLOCK operation and commands are set to M_AUTO_REGISTER, this parameter's value should be at least twice the clock period. To learn the length of the clock period (in Hz), use MsysIoInquire() with M_CLOCK_FREQUENCY.

Duration

Specifies the duration of the pulse if the command specified with Operation is M_PULSE_HIGH or M_PULSE_LOW. If the I/O command list was allocated with M_CLOCK as the counter source, specify the delay in seconds. Otherwise, specify it in number of counter increments. When adding other types of commands, set this parameter to M_DEFAULT.

BitToOperate

Specifies the bit of the I/O command register to affect with the command. This parameter can be set to the following value:

function map For specifying the bit of the I/O command register to operate
Click to summarizeValue Description MIL system-specific
tooltip (‡)
Click to summarize M_IO_COMMAND_BITn

Specifies that the command must affect bit n of the I/O command register, where n can be a value of 0 to 7.

Note that, if you need to route the state of the bit to an auxiliary signal, use MsysControl() with M_IO_SOURCE before you change the state of the bit.

When performing multiple automatically registered operations (using M_AUTO_REGISTER), each automatically registered operation must affect a unique I/O command register bit; otherwise, the last automatically registered operation will override the previous that affects the same register bit.

(summarize)
‡ a t
U28		 w
U53		 z
MIL system specific

For the Matrox Iris GTR, n can be a value from 0 to 3.

 ‡ t
U28
CommandStatusPtr
Accepts the following address:

  • Data type: address of a MIL_INT

Specifies the address in which to write whether the command was successfully added to the list. You can set this parameter to M_NULL if this information is not required.

This parameter can return one of the following values:

function map For returning the status of the command registration
Click to summarizeValue Description MIL system-specific
tooltip (‡)
Click to summarize M_NULL

Specifies that the function successfully scheduled the command.

 ‡ a t
U28		 w
U53		 z
Click to summarize M_INVALID

Specifies that the moment at which to execute the command had elapsed when the function was executed.

 ‡ a t
U28		 w
U53		 z
Click to summarize M_UNKNOWN

Specifies that the function encountered an error and could not schedule the command.

 ‡ a t
U28		 w
U53		 z
Return value
The returned value is M_NULL if the function successfully scheduled the command, M_INVALID if the moment at which to execute the command had elapsed when the function was executed, and M_UNKNOWN if the function encountered an error or if the CommandStatusPtr parameter was set to M_NULL.
Compilation information
Header Include mil.h.
Library Use mil.lib.
DLL Requires mil.dll.
EDGE FALLING EDGE RISING IMPULSE NONE PULSE HIGH PULSE LOW AUTO REGISTER AUTO REGISTER CANCEL LATCHn REFERENCE VALUE CURRENT IO COMMAND BITn NULL INVALID UNKNOWN AUTO REGISTER AUTO REGISTER CANCEL M_LATCHn M_IO_COMMAND_BITn