| Trees | Indices | Help |
|
|---|
|
|
SIMulation Workbench PYToolkit Server API.
This module provides access to the guirpcsrv facility enabling the user to call
server API functions from a remote client. This is the same facility used by the
java HMI client. The user must first connect to the guirpcsrv running on the
real-time host system. The host may be the same system as the one running the
script, or remotely connected via a standard network connection.
Module usage is best seen by example:
import simwbPath
import simwbServerAPI
simwbServerAPI.connect("localhost")
board_id = simwbServerAPI.simwbConstants.BTI_Lx429
ccurAsyncIO_arinc429SetInvertParityLabel(boardId,1,0,12,1)
simwbServerAPI.disconnect()
First we connect to the real-time host (using the network name, or "localhost"
if the script is run on the same machine).
All procedure documentation is avialable via the standard python techniques, i.e.
pydoc and help().
There is a companion module, simwbConstants, that is used to define internal
SimWB constant values. This module is automatically imported by simwbServerAPI.
Copyright (c) Concurrent Real-Time
| Functions | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
| Variables | |
| PYTHON2 is True when running Python 2.x | |
| PYTHON3 is True when running Python 3.x | |
| PYTHON_VERSION is an integer 3-tuple of the running Python version | |
__package__ = None
|
|
isConnected = False
|
|
| Function Details |
ccurAsyncIO_1553BCStart
Start the specified Bus controller .
Function prototype
int ccurAsyncIO_1553BCStart(int boardId,int boardNum,int channel )
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the BC is running on. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_1553BCStop
Stop the specified Bus controller .
Function prototype
int ccurAsyncIO_1553BCStop(int boardId,int boardNum,int channel )
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the BC is running on. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_1553RTDisableBus
Disable BUS A/B or both for the specified RT running the given channel on a 1553 board. At the present, only DDC 1553 board support this feature.
Function prototype
int ccurAsyncIO_1553RTDisableBus(int boardId,int boardNum,int channel,int rtAddr,int bus )
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The 1553 channel number the RT is running on.
rtAddr The address of the RT to start. .
bus The Bus to disable for the given RT; either DDC1553_RT_BUS_NONE(0), DDC1553_RT_BUS_A(1), DDC1553_RT_BUS_B(2) or DDC1553_RT_BUS_A|DDC1553_RT_BUS_B(3) to disable both bus A and B.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_1553RTResetErrorInjection
Reset error injection features for the given 1553 board. At the present, only DDC 1553 (DDC1553_67) board support this feature. This will re enable communication on both bus A and B for the RT.
Function prototype
int ccurAsyncIO_1553RTResetErrorInjection(int boardId,int boardNum,int channel,int rtAddr)
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The 1553 channel number the RT is running on.
rtAddr The address of the RT to start. .
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_1553RTStart
Stop the specified Bus controller .
Function prototype
int ccurAsyncIO_1553RTStart(int boardId,int boardNum,int channel,int rtAddr )
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the RT is running on.
rtAddr The address of the RT to start. Use -1 to start all RT's.
defined on ithe channel. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_1553RTStop
Stop the specified RT.
Function prototype
int ccurAsyncIO_1553RTStop(int boardId,int boardNum,int channel,int rtAddr )
Function arguments
boardId integer with the board Id: Only DDC1553_67 supported at this time.
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the RT is running on.
rtAddr The address of the RT to start. Use -1 to start all RT's.
defined on ithe channel. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_CPFPGAARV_sentResumeSENTId Same as ccurAsyncIO_sentResumeSENTId with boardId == CP_FPGA_ArV |
ccurAsyncIO_DA3218WavePause
Pause output of wave form on the given board.
Function prototype
int ccurAsyncIO_DA3218WavePause(int boardNum)
Function arguments
boardNum Number of the DA3218:Wave board to pause. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveResume
Resume output of wave form on the given board.
Function prototype
int ccurAsyncIO_DA3218WaveResume(int boardNum)
Function arguments
boardNum Number of the DA3218:Wave board to pause. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveSetAmplitudeBias
Set the amplitude/bias for a combination of channels on the specified board. Only the channels specified
in the channel mask are affected.
Function prototype
int ccurAsyncIO_DA3218WaveSetAmplitudeBias(int boardNum,int channelMask,double amplitude, double bias )
Function arguments
boardNum Number of the DA3218:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
amplitude The new amplitude. The initial amplitude/bias when the board is initialized is 1.0 and 0.0 .
bias The new bias.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveSetFrequencyWave
Set the frequency and/or wave file for a combination of channels on the specified board.
If the waveFile is NULL, only the frequency is set. When the wave file is given, both frequency and
wave file must be given.
This call will reset the hardware on the board and reinitialize all the running wave forms on all channels
to their initial conditions. If the board has been configured as external sync via the GUI, the board will
need to be triggered again to output the data on all channels.
Function prototype
int ccurAsyncIO_DA3218WaveSetFrequencyWave(int boardNum,int channelMask,double frequency,char *waveFile )
Function arguments
boardNum Number of the DA3218:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
frequency The new frequency.
waveFile The name of the new wave file. The wave file must be in the projects/WaveForms directory.
If this is NULL or the length of the file == 0, only the frequency is set and the wave form is not altered.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveSetPhase
Set the phase for a combination of channels on the specified board. Only the channels specified
in the channel mask are affected.
Function prototype
int ccurAsyncIO_DA3218WaveSetPhase(int boardNum,int channelMask,double phase )
Function arguments
boardNum Number of the DA3218:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
phase The new phase in degrees. The phase is additive, doing 2 30 deg phase change will result in the final wave being out of phase by 60 degrees.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveStart
Start output of wave form on the given board.
Function prototype
int ccurAsyncIO_DA3218WaveStart(int boardNum)
Function arguments
boardNum Number of the DA3218:Wave board to start. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DA3218WaveStop
Stop output of wave form on the given board.
Function prototype
int ccurAsyncIO_DA3218WaveStop(int boardNum)
Function arguments
boardNum Number of the DA3218:Wave board to stop. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_DDC_1553BCStart
Start the specified Bus Controller on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553BCStart(int boardNum,int channel )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the BC is running on.
defined on ithe channel. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553BCStop
Stop the specified Bus Controller on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553BCStop(int boardNum,int channel )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the BC is running on. channel must be a number between 0 and 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553BC_BusSelect
Disable BUS A/B or both for the specified RT running the given channel on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553BC_BusSelect(int boardNum,int channel,int msgType,int rtSrc,int mbSrc,int rtDest,int mbDest, int bus )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The 1553 channel number the RT is running on.
msgType the BC message type RT2BC == 2, BC2RT == 1 or RT2RT == 3 (use -1 to set bus independent of message type).
rtSrc The source RT number (Use -1 to select all source RT's).
mbSrc The source mailbox number (Use -1 to select all mailboxes for the selected RT)
rtDest The destination RT number (Use -1 to select all destination RT's)
mbSrc The destination mailbox number (Use -1 to select all destination mailboxes for the selected RT)
bus Bus selector. bus A == 1, bus B ==2 bus A and B == 3.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553RTDisableBus
Disable BUS A/B or both for the specified RT running the given channel on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553RTDisableBus(int boardNum,int channel,int rtAddr,int bus )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The 1553 channel number the RT is running on.
rtAddr The address of the RT to start. .
bus The Bus to disable for the given RT; either DDC1553_RT_BUS_NONE(0), DDC1553_RT_BUS_A(1), DDC1553_RT_BUS_B(2) or DDC1553_RT_BUS_A|DDC1553_RT_BUS_B(3) to disable both bus A and B.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553RTResetErrorInjection
Reset error injection features for the given DDC 1553 board. This will re enable communication on both bus A and B for the RT.
Function prototype
int ccurAsyncIO_DDC_1553RTResetErrorInjection(int boardNum,int channel,int rtAddr)
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The 1553 channel number the RT is running on.
rtAddr The address of the RT to start. .
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553RTStart
Start the specified RT on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553RTStart(int boardNum,int channel,int rtAddr )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the RT is running on. channel must be a number between 0 and 3.
rtAddr The address of the RT to start. Use -1 to start all RT's.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_DDC_1553RTStop
Stop the specified RT on a DDC 1553 board.
Function prototype
int ccurAsyncIO_DDC_1553RTStop(int boardNum,int channel,int rtAddr )
Function arguments
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the 1553 channel the RT is running on. channel must be a number between 0 and 3.
rtAddr The address of the RT to start. Use -1 to start all RT's.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
-1 Bad boardId
|
ccurAsyncIO_afdxBoardNameGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxBoardNameGetDefaultTxFlagsMsg(char * boardName,int boardNumber,int vlId,char *msgName)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxBoardNameGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxBoardNameGetDefaultTxRateMsg(char * boardName,int boardNumber,int vlId,char *msgName )
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxBoardNameGetTxFlagsMsg
Return the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxBoardNameGetTxFlagsMsg(char * boardName,int boardNumber,int vlId,char *msgName )
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxBoardNameGetTxRateMsg
Return the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxBoardNameGetTxRateMsg(char * boardName,int boardNumber,int vlId,char *msgName )
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxBoardNamePauseMsg
Pause the selected AFDX message. Sending of the AFDX message can be resumed with a call to ccurAsyncIO_afdxResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_afdxBoardNamePauseMsg(char * boardName,int boardNumber,int vlId,char *msgName)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber integer with the board number where the label is defined . The first board is 1.
vlId integer with the virtual link number where the message is defined .
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxBoardNameResumeMsg
Resume sending the selected AFDX message after the message has been paused with a call to ccurAsyncIO_afdxPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_afdxBoardNameResumeMsg(char * boardName,int boardNumber,int vlId,char *msgName)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber integer with the board number where the message is defined . The first board is 1.
vlId integer with the virtual link where the message is defined .
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxBoardNameSetFIFOTxOnChangeMsg
Set/reset the AFDX FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_afdxBoardNameSetFIFOTxOnChangeMsg(char * boardName,int boardNumber,int vlId,char *msgName,int txOnChange)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_afdxBoardNameSetNetConfigMsg
Switch the board, vlId,message combination to transmission on both port, port A,port B delayA or DelayB .
Function prototype
int ccurAsyncIO_afdxBoardNameSetNetConfigMsg(char * boardName,int boardNum,int vlId,char *msgName ,int netConfig,int skew)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number where the message is defined. The first board is # 1.
vlId The virtual link Id for the message
msgName The name of the message on which to change the configuration
netConfig The new configuration for transmission, must be one of AFDX_NetConfig codes.
When delay A or B is specified the skew must be given.
skew The difference in transmission time betwee port A and B. Must be given in microseconds. The maximum value is 65535.
returns 0 Always.
|
ccurAsyncIO_afdxBoardNameSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_afdxBoardNameSetTxFIFOToScheduledMsg(char * boardId,int boardNumber,int vlId,char *msgName,int msRate)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_afdxBoardNameSetTxRateMsg
Change the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxBoardNameSetTxRateMsg(char * boardId,int boardNumber,int vlId,char *msgName ,int msRate)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_afdxBoardNameSetTxScheduledToFIFOMsg
Switch the AFDX message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_afdxBoardNameSetTxScheduledToFIFOMsg(char * boardName,int boardNumber,int vlId,char *msgName)
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_afdxBoardNameTXQueueNowMsg
Request that an AFDX message defined in FIFO queueing mode be sent now.
FIFO/Queue mode AFDX message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_afdxBoardNameTXQueueNowMsg(char * boardName,int boardNumber,int vlId ,char *msgName )
Function arguments
boardName The board name for the the AFDX board vendor .One of "AIM-AFDX" or "AIT-AFDX".
boardNumber integer with the board number where the label is defined . The first board is 1.
vlId integer with the virtual link corresponding to the message.
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the AFDX output message associated with the RTDB item. The RTDB item must be mapped to an AFDX output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_afdxGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_afdxGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxGetDefaultTxFlagsMsg(int boardNum,int vlId,char *msgName)
Function arguments
boardNum The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the AFDX output message associated with the RTDB item.
The RTDB item must be mapped to an AFDX output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_afdxGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_afdxGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxGetDefaultTxRateMsg(int boardNum,int vlId,char *msgName)
Function arguments
boardNum The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxGetTxFlags
Return the transmit flags of the AFDX output message associated with the RTDB item. The RTDB item must be mapped to an AFDX output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_afdxGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_afdxGetTxFlagsMsg
Return the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxGetTxFlagsMsg(int boardNum,int vlId,char *msgName)
Function arguments
boardNum The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxGetTxRate
Return the transmit rate of the AFDX output message associated with the RTDB item. The RTDB item must be mapped to an AFDX output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_afdxGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_afdxGetTxRateMsg
Return the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxGetTxRateMsg(int boardNum,int vlId,char *msgName)
Function arguments
boardNum The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_afdxPauseItemMsgName
Pause the AFDX message mapped to the specified RTDB item. Sending of the message can be resumed with a call to ccurAsyncIO_afdxResumeItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_afdxPauseItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an AFDX message, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxPauseMsg
Pause the selected AFDX message. Sending of the AFDX message can be resumed with a call to ccurAsyncIO_afdxResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_afdxPauseMsg(int boardNum,int vlId,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
vlId integer with the virtual link number where the message is defined .
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxResumeItemMsgName
Resume sending the selected AFDX message after it has been paused with a call to ccurAsyncIO_afdxPauseItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_afdxResumeItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an AFDX message. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxResumeMsg
Resume sending the selected AFDX message after the message has been paused with a call to ccurAsyncIO_afdxPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_afdxResumeMsg(int boardNum,int vlId,char *msgName )
Function arguments
boardNum integer with the board number where the message is defined . The first board is 1.
vlId integer with the virtual link where the message is defined .
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxSetFIFOTxOnChange
Set/reset the FIFO/Queue message where the point is mapped to transmit on change. When Tx on change is set, the message is sent whenever its value changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_afdxSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change message flag.
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_afdxSetFIFOTxOnChangeMsg
Set/reset the AFDX FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_afdxSetFIFOTxOnChangeMsg(int boardNum,int vlId,char *msgName,int txOnChange)
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_afdxSetNetConfigMsg
Switch the board, vlId,message combination to transmission on both port, port A,port B delayA or DelayB .
Function prototype
int ccurAsyncIO_afdxSetNetConfigMsg(int boardNum,int vlId,char *msgName ,int netConfig,int skew)
Function arguments
boardNum The board number where the message is defined. The first board is # 1.
vlId The virtual link Id for the message
msgName The name of the message on which to change the configuration
netConfig The new configuration for transmission, must be one of AFDX_NetConfig codes.
When delay A or B is specified the skew must be given.
skew The difference in transmission time betwee port A and B. Must be given in microseconds. The maximum value is 65535.
returns 0 Always.
|
ccurAsyncIO_afdxSetNetConfigName
Switch the messages where the point is mapped to transmission on both port, port A,port B delayA or DelayB .
Function prototype
int ccurAsyncIO_afdxSetNetConfigName(char *pointName ,int netConfig,int skew)
Function arguments
pointName The name of ithe RTDB item for which we want to change the transmission mode.
netConfig The new configuration for transmission, must be one of AFDX_NetConfig codes.
When delay A or B is specified the skew must be given.
skew The difference in transmission time betwee port A and B. Must be given in microseconds. The maximum value is 65535.
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_afdxSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_afdxSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_afdxSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_afdxSetTxFIFOToScheduledMsg(int boardNum,int vlId,char *msgName,int msRate)
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_afdxSetTxRate
Change the transmit rate of the AFDX message associated with the RTDB item. The RTDB item must be mapped to an AFDX output message.
Function prototype
int ccurAsyncIO_afdxSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_afdxSetTxRateMsg
Change the transmit rate of an AFDX message by specifying the board number , VL Id and message name .
Function prototype
int ccurAsyncIO_afdxSetTxRateMsg(int boardNum,int vlId,char *msgName,int msRate)
Function arguments
boardNum The board number . First board is 1.
vlId The virtual link Id .
msgName The name of the AFDX message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_afdxSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_afdxSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTAFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_afdxSetTxScheduledToFIFOMsg
Switch the AFDX message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_afdxSetTxScheduledToFIFOMsg(int boardNum,int vlId,char *msgName)
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
vlId the virtual link id on which the message is defined.
msgName The name of the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_afdxTXQueueNowMsg
Request that an AFDX message defined in FIFO queueing mode be sent now.
FIFO/Queue mode AFDX message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_afdxTXQueueNowMsg(int boardNum,int vlId,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
vlId integer with the virtual link corresponding to the message.
msgName The name of the AFDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_afdxTXQueueNowName
Request that an AFDX message defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple AFDX messages , all
of the them will be transmitted.
FIFO / Queue AFDX messages created in the configuration with TX on change set are only transmitted upon user request.
Function prototype
int ccurAsyncIO_afdxTXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the AFDX message we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_ao16Pause
Pause output of wave form on the given board.
Function prototype
int ccurAsyncIO_ao16Pause(int boardNum)
Function arguments
boardNum Number of the AO16:Wave board to pause. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16Resume
Resume output of wave form on the given board.
Function prototype
int ccurAsyncIO_ao16Resume(int boardNum)
Function arguments
boardNum Number of the AO16:Wave board to pause. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16SetAmplitudeBias
Set the amplitude/bias for a combination of channels on the specified board. Only the channels specified
in the channel mask are affected.
Function prototype
int ccurAsyncIO_ao16SetAmplitudeBias(int boardNum,int channelMask,double amplitude, double bias )
Function arguments
boardNum Number of the AO16:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
amplitude The new amplitude. The initial amplitude/bias when the board is initialized is 1.0 and 0.0 .
bias The new bias.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16SetFilter
Set output filter of wave form on the given board.
Function prototype
int ccurAsyncIO_ao16SetFilter(int boardNum,int filter)
Function arguments
boardNum Number of the AO16:Wave board to pause. First board is 1.
filter Filter type 0 == NONE, 1 == FILTER_A , 2 == FILTER_B
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16SetFrequencyWave
Set the frequency and/or wave file for a combination of channels on the specified board.
If the waveFile is NULL, only the frequency is set. When the wave file is given, both frequency and
wave file must be given.
This call will reset the hardware on the board and reinitialize all the running wave forms on all channels
to their initial conditions. If the board has been configured as external sync via the GUI, the board will
need to be triggered again to output the data on all channels.
Function prototype
int ccurAsyncIO_ao16SetFrequencyWave(int boardNum,int channelMask,double frequency,char *waveFile )
Function arguments
boardNum Number of the AO16:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
frequency The new frequency.
waveFile The name of the new wave file. The wave file must be in the projects/WaveForms directory.
If this is NULL or the length of the file == 0, only the frequency is set and the wave form is not altered.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16SetPhase
Set the phase for a combination of channels on the specified board. Only the channels specified
in the channel mask are affected.
Function prototype
int ccurAsyncIO_ao16SetPhase(int boardNum,int channelMask,double phase )
Function arguments
boardNum Number of the AO16:Wave board to set the frequency/wave file. First board is 1.
channelMask Bit mask specifying on which channels to set the frequency.
Mask: 1 == channel 0 only
Mask: 2 == channel 1 only
Mask: 5 == channel 0 and 2
phase The new phase in degrees. The phase is additive, doing 2 30 deg phase change will result in the final wave being out of phase by 60 degrees.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16Start
Start output of wave form on the given board.
Function prototype
int ccurAsyncIO_ao16Start(int boardNum)
Function arguments
boardNum Number of the AO16:Wave board to start. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_ao16Stop
Stop output of wave form on the given board.
Function prototype
int ccurAsyncIO_ao16Stop(int boardNum)
Function arguments
boardNum Number of the AO16:Wave board to stop. First board is 1.
returns 0 On success.
< -1 If the command output queue is full.
|
ccurAsyncIO_arinc429GetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the ARINC 429 label associated with the RTDB item. The RTDB item must be mapped to an ARINC 429 output label.
If the item is mapped to more than one output label, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_arinc429GetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429GetDefaultTxFlagsLabel
Return the default transmit flags as configured in the RTDB of an ARINC 429 label by specifying the board number , channel and label where the label is defined.
Function prototype
int ccurAsyncIO_arinc429GetDefaultTxFlagsLabel(int boardId,int boardNum,int channelNum,int labelNum)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number . First board is 1.
channelNum The channel number where the label is sent.
labelNum The ARINC label for which to change the schedule rate.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_arinc429GetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the ARINC 429 label associated with the RTDB item. The RTDB item must be mapped to an ARINC 429 output label.
If the item is mapped to more than one output label, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_arinc429GetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429GetDefaultTxRateLabel
Return the default transmit rate as configured in the RTDB of an ARINC 429 label by specifying the board number , channel and label where the label is defined.
Function prototype
int ccurAsyncIO_arinc429GetDefaultTxRateLabel(int boardId,int boardNum,int channelNum,int labelNum)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number . First board is 1.
channelNum The channel number where the label is sent.
labelNum The ARINC label for which to change the schedule rate.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_arinc429GetLastRXIntervalLabel
Returns the interval in micro seconds between the last 2 updates the specified label .
It is used to check that the transmitting device is transmitting at a regular interval.
Function prototype
int ccurAsyncIO_arinc429GetLastRXIntervalLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
returns The value in micro seconds or < 0 if error.
|
ccurAsyncIO_arinc429GetRxCountLabel
Get the number of messages received for the selected ARINC label .
Function prototype
int ccurAsyncIO_arinc429GetRxCountLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId The board type where the CAN is defined. I.e. one of ARINC429 or BTI_Lx429 or DD_429_92.
boardNum integer with the board number where the label is defined . The first board is 1.
channelNum integer with the channel number.
labelNum The ARINC label number.
returns >= 0 The number of message received.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429GetTimeSinceLastRXLabel
Returns the number of micro seconds elapsed since the specified label point was last received .
Function prototype
int ccurAsyncIO_arinc429GetTimeSinceLastRXLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
returns The number of micro seconds if > 0.
< 0 RTDB_POINTNOTFOUND if the label cannot be found.
|
ccurAsyncIO_arinc429GetTxCountLabel
Get the number of messages transmitted for the selected ARINC label .
Function prototype
int ccurAsyncIO_arinc429GetTxCountLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId The board type where the CAN is defined. I.e. one of ARINC429 or BTI_Lx429 or DD_429_92.
boardNum integer with the board number where the label is defined . The first board is 1.
channelNum integer with the channel number.
labelNum The ARINC label number.
returns >= 0 The number of message transmitted.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429GetTxFlags
Return the transmit flags of the ARINC 429 label associated with the RTDB item. The RTDB item must be mapped to an ARINC 429 output label.
If the item is mapped to more than one output label, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_arinc429GetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429GetTxFlagsLabel
Return the transmit flags of an ARINC 429 label by specifying the board number , channel and label where the label is defined.
Function prototype
int ccurAsyncIO_arinc429GetTxFlagsLabel(int boardId,int boardNum,int channelNum,int labelNum)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number . First board is 1.
channelNum The channel number where the label is sent.
labelNum The ARINC label for which to change the schedule rate.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_arinc429GetTxRate
Return the transmit rate of the ARINC 429 label associated with the RTDB item. The RTDB item must be mapped to an ARINC 429 output label.
If the item is mapped to more than one output label, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_arinc429GetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429GetTxRateLabel
Return the transmit rate of an ARINC 429 label by specifying the board number , channel and label where the label is defined.
Function prototype
int ccurAsyncIO_arinc429GetTxRateLabel(int boardId,int boardNum,int channelNum,int labelNum)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum The board number . First board is 1.
channelNum The channel number where the label is sent.
labelNum The ARINC label for which to change the schedule rate.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_arinc429HaltChannel
Halt the sepcified ARINC429 channel .
Function prototype
int ccurAsyncIO_arinc429HaltChannel(int boardId,int boardNum,int channel )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number where the channel is to be halted. The first board is 1.
channel The number of the ARINC 429 channel to halt. This will stop transmission of all the labels
defined on ithe channel. channel must be a number between 0 and 15.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
|
ccurAsyncIO_arinc429HaltPointChannel
Halt the ARINC429 channel on which the output point is defined.
Function prototype
int ccurAsyncIO_arinc429HaltPointChannel(char *pointName )
Function arguments
pointName The name of the RTDB item that sets what channel will be halted. This will stop transmission of all the labels
defined on the same channel as pointName.
returns 0 On success.
< 0 CSCRIPT_NOTARINCPOINT, CSCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429PauseItemLabelName
Pause the label mapped to the specified RTDB item. Sending of the label can be resumed with a call to ccurAsyncIO_arinc429ResumeItemLabel.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_arinc429PauseItemLabelName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the label. If the point is not mapped to an ARINC429 label, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429PauseLabel
Pause the selected ARINC 429 label. Sending of the label can be resumed with a call to ccurAsyncIO_arinc429ResumeLabel.
The label must be defined as a scheduled label for this to work,
Function prototype
int ccurAsyncIO_arinc429PauseLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum integer with the board number where the label is defined . The first board is 1.
channelNum integer with the channel number where the label is defined .
labelNum integer with the label number to resume.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429ResumeItemLabelName
Resume sending the selected label after the label has been paused with a call to ccurAsyncIO_arinc429PauseItemLabel.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_arinc429ResumeItemLabelName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the label. If the point is not mapped to an ARINC429 label. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429ResumeLabel
Resume sending the selected label after the label has been paused with a call to ccurAsyncIO_arinc429PauseLabel.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_arinc429ResumeLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum integer with the board number where the label is defined . The first board is 1.
channelNum integer with the channel number where the label is defined .
labelNum integer with the label number to resume.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429SetFIFOTxOnChange
Set/reset the FIFO label where the point is mapped to transmit on change. When Tx on change is set, the label is sent whenever its value changes.
When Tx on change is reset, the label is only sent by user request.
Function prototype
int ccurAsyncIO_arinc429SetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change label flag.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_arinc429SetFIFOTxOnChangeLabel
Set/reset transmit on change state on the FIFO label where the point is mapped. When Tx on change is set, the label is sent whenever its value changes.
Function prototype
int ccurAsyncIO_arinc429SetFIFOTxOnChangeLabel(int boardId,int boardNum,int channelNum,int labelNum, int txOnChange)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
txOnChange : 1 to set tx on change flag, 0 to reset the tx on change flag.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the label cannot be found.
|
ccurAsyncIO_arinc429SetInvertParity
Force parity inversion on arinc 429 output point.
Function prototype
int ccurAsyncIO_arinc429SetInvertParity(char *pointName,int enable)
Function arguments
pointName The name of the point for which we want to set/reset parity inversion.
enable Set to 1 to enable parity inversion. Set to 0 to reset parity inversion.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_arinc429SetInvertParityLabel
Force parity inversion on arinc 429 output label.
Function prototype
int ccurAsyncIO_arinc429SetInvertParityLabel(int boardId,int boardNum,int channelNum,int labelNum ,int enable)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
enable Set to 1 to enable parity inversion. Set to 0 to reset parity inversion.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND .
|
ccurAsyncIO_arinc429SetTxFIFOToScheduled
Switch the label where the point is mapped from FIFO to scheduled transmission mode . If the label is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the label can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_arinc429SetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the label was initially setup as a FIFO label when
configuring the RTDB, the label does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429SetTxFIFOToScheduledLabel
Switch the given label on the board type and number from FIFO to scheduled transmission mode . If the label is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the label can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_arinc429SetTxFIFOToScheduledLabel(int boardId,int boardNum,int channelNum,int labelNum ,int msRate)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the label was initially setup as a FIFO label when
configuring the RTDB, the label does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given pItem.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND .
|
ccurAsyncIO_arinc429SetTxRate
Change the transmit rate of the ARINC 429 label associated with the RTDB item. The RTDB item must be mapped to an arinc output label.
Function prototype
int ccurAsyncIO_arinc429SetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429SetTxRateLabel
Change the transmit rate of an ARINC 429 label by specifying the board number , channel and label where the label is defined.
Function prototype
int ccurAsyncIO_arinc429SetTxRateLabel(int boardId,int boardNum,int channelNum,int labelNum,int msRate)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum The board number . First board is 1.
channelNum The channel number where the label is sent.
labelNum The ARINC label for which to change the schedule rate.
msRate The transmit rate in milliseconds.
returns < 0 If the label could not be found
|
ccurAsyncIO_arinc429SetTxScheduledToFIFO
Switch the label where the point is mapped from scheduled transmission mode to FIFO mode. If the label is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the label is saved so that it can be restored when the label is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_arinc429SetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_arinc429SetTxScheduledToFIFOLabel
Switch the ARINC 429 label where the point is mapped from scheduled transmission mode to FIFO mode. If the label is already in FIFO mode, nothing happens and the call just
returns with 0 error code.
The current scheduled rate for the label is saved so that it can be restored when the label is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_arinc429SetTxScheduledToFIFOLabel(int boardId,int boardNum,int channelNum,int labelNum)
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number (first board is 0) where the label is defined.
channelNum The channel number (0-15).
labelNum The label number.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429StartChannel
Start the sepcified ARINC429 channel .
Function prototype
int ccurAsyncIO_arinc429StartChannel(int boardId,int boardNum,int channel )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx42 or DD_429_929
boardNum The board number where the channel is to be started. The first board is 1.
channel The number of the ARINC 429 channel to start. This will restart transmission of all the labels
defined on ithe channel. channel must be a number between 0 and 15.
returns 0 On success.
< 0 SCRIPT_BADARINCBOARD,SCRIPT_BADARINCHANNEL .
|
ccurAsyncIO_arinc429StartPointChannel
Start the ARINC429 channel on which the output point is defined.
Function prototype
int ccurAsyncIO_arinc429StartPointChannel(char *pointName )
Function arguments
pointName The name of the RTDB item that sets what channel will be started. This will restart transmission of all the labels
defined on the same channel as pointName.
returns 0 On success.
< 0 CSCRIPT_NOTARINCPOINT, CSCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_arinc429TXQueueNowLabel
Request that the value of label defined in FIFO queueing mode be sent now.
FIFO mode labels are only transmitted upon user request.
Function prototype
int ccurAsyncIO_arinc429TXQueueNowLabel(int boardId,int boardNum,int channelNum,int labelNum )
Function arguments
boardId integer with the board Id. Either ARINC429 or BTI_Lx429 or DD_429_92
boardNum integer with the board number where the label is defined . The first board is 1.
channelNum integer with the channel number where the label is defined .
labelNum integer with the label number to be sent .
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_arinc429TXQueueNowName
Request that the value of label defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple ARINC label , all
of the them will be transmitted.
FIFO mode labels with IOFL_TXONCHANGE are only transmitted upon user request.
Function prototype
int ccurAsyncIO_arinc429TXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the label we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the CAN output message associated with the RTDB item. The RTDB item must be mapped to a CAN output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_canGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_canGetDefaultTxFlagsCANId
Return the default transmit rate as configured in the RTDB of an CAN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_canGetDefaultTxFlagsCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number . First board is 1.
netNum The net number.
canId The CAN id.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_canGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the CAN output message associated with the RTDB item.
The RTDB item must be mapped to a CAN output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_canGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_canGetDefaultTxRateCANId
Return the default transmit rate as configured in the RTDB of a CAN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_canGetDefaultTxRateCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number . First board is 1.
netNum The net number.
canId The CAN id.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_canGetLastRXIntervalCANId
Returns the interval in micro seconds between the last 2 updates the specified label .
It is used to check that the transmitting device is transmitting at a regular interval.
Function prototype
int ccurAsyncIO_canGetLastRXIntervalCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId integer with the board Id. Either CANIO_ESD405 or CANIO_PEAK
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
canId The CANid.
returns The value in micro seconds or < 0 if error.
|
ccurAsyncIO_canGetRxCountCANId
Get the number of messages received for the selected CAN id.
Function prototype
int ccurAsyncIO_canGetRxCountCANId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
canId The CAN id as defined in the RTDB configuration.
returns >= 0 The number of message received.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canGetTimeSinceLastRXCANId
Returns the number of micro seconds elapsed since the specified CAN id was last received .
Function prototype
int ccurAsyncIO_canGetTimeSinceLastRXCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId integer with the board Id. Either CANIO_ESD405 or CANIO_PEAK
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
canId The CANid.
returns The number of micro seconds if > 0.
< 0 RTDB_POINTNOTFOUND if the label cannot be found.
|
ccurAsyncIO_canGetTxCountCANId
Get the number of messages transmitted for the selected CAN id.
Function prototype
int ccurAsyncIO_canGetTxCountCANId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
canId The CAN id as defined in the RTDB configuration.
returns >= 0 The number of message transmitted.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canGetTxFlags
Return the transmit flags of the CAN output message associated with the RTDB item. The RTDB item must be mapped to an CAN output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_canGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_canGetTxFlagsCANId
Return the transmit rate of an CAN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_canGetTxFlagsCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number . First board is 1.
netNum The net number.
canId The CAN id.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_canGetTxRate
Return the transmit rate of the CAN output message associated with the RTDB item. The RTDB item must be mapped to a CAN output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_canGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_canGetTxRateCANId
Return the transmit rate of a CAN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_canGetTxRateCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number . First board is 1.
netNum The net number.
canId The CAN id.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_canPauseCANId
Pause the selected CAN message. Sending of the CAN message can be resumed with a call to ccurAsyncIO_canResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_canPauseCANId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
canId The CAN id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canResumeCANId
Resume sending the selected CAN message after the message has been paused with a call to ccurAsyncIO_canPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_canResumeCANId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the message is defined . The first board is 1.
netNum integer with the net number where the CAN id is defined .
canId The CAN id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canSetFIFOTxOnChange
Set/reset the FIFO CAN id where the point is mapped to transmit on change. When Tx on change is set, the CAN id is sent whenever its value changed.
When Tx on change is reset, the CAN message is only by user request.
Function prototype
int ccurAsyncIO_canSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name ofi the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change CAN id flag.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_canSetFIFOTxOnChangeCANId
Set/reset the FIFO CAN id to transmit on change. When Tx on change is set, the CAN id is sent whenever its value changed.
When Tx on change is reset, the CAN message is only by user request.
Function prototype
int ccurAsyncIO_canSetFIFOTxOnChangeCANId(int boardId,int boardNum,int netNum,int canId,int txOnChange )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the CAN Id is defined . The first board is 1.
netNum integer with the net number where the CAN Id is defined .
canId integer with the CAN Id to be sent .
txOnChange Boolean indicating whether to set or reset the Tx on change CAN id flag.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTARINCOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_canSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_canSetTxFIFOToScheduled(char *pointName,float msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_canSetTxRate
Change the transmit rate of the CAN message associated with the RTDB item. The RTDB item must be mapped to a CAN output message.
Function prototype
int ccurAsyncIO_canSetTxRate(char *pointName ,float msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_canSetTxRateCANId
Change the transmit rate of a CAN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_canSetTxRateCANId(int boardId,int boardNum,int netNum,int canId ,float msRate)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number . First board is 1.
netNum The net number.
canId The CANid.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_canSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_canSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_canSetTxScheduledToFIFOCANId
Switch the CAN message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_canSetTxScheduledToFIFOCANId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum The board number (starting at 1) where the CAN message is defined.
netNum the net number on which the message is defined.
canId The CAN id.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_canTXQueueNowCANId
Request that the value of label defined in FIFO queueing mode be sent now.
FIFO mode labels are only transmitted upon user request.
Function prototype
int ccurAsyncIO_canTXQueueNowCANId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the CAN is defined. I.e. one of CANIO_ESD405(15) or CANIO_PEAK (21).
boardNum integer with the board number where the CAN Id is defined . The first board is 1.
netNum integer with the net number where the CAN Id is defined .
canId integer with the CAN Id to be sent .
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_canTXQueueNowName
Request that the value of CAN Id defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple CAN Id's , all
of the them will be transmitted.
FIFO mode CAN Id with IOFL_TXONCHANGE flag are only transmitted upon user request.
Function prototype
int ccurAsyncIO_canTXQueueNowName(char *pointName )
Function arguments
pointName Name of the RTDB item mapped to the label we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the CIGI output message associated with the RTDB item.
The RTDB item must be mapped to an CIGI output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_cigiIOGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTiNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_cigiIOGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an CIGI message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_cigiIOGetDefaultTxFlagsMsg(char *msgName)
Function arguments
msgName The name of the CIGI message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_cigiIOGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the CIGI output message associated with the RTDB item.
The RTDB item must be mapped to an CIGI-IO output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_cigiIOGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_cigiIOGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an CIGI message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_cigiIOGetDefaultTxRateMsg(char *msgName)
Function arguments
msgName The name of the CIGI message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_cigiIOGetTxFlags
Return the transmit flags of the CIGI output message associated with the RTDB item. The RTDB item must be mapped to an CIGI output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_cigiIOGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_cigiIOGetTxFlagsMsg
Return the transmit rate of an CIGI message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_cigiIOGetTxFlagsMsg(char *msgName)
Function arguments
msgName The name of the CIGI message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_cigiIOGetTxRate
Return the transmit rate of the CIGI output message associated with the RTDB item. The RTDB item must be mapped to an CIGI output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_cigiIOGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_cigiIOGetTxRateMsg
Return the transmit rate of an CIGI message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_cigiIOGetTxRateMsg(char *msgName)
Function arguments
msgName The name of the CIGI message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_cigiIOPauseItemMsgName
Pause the CIGI-IO message mapped to the specified RTDB item. Sending of the message can be resumed with a call to ccurAsyncIO_cigiIOResumeItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_cigiIOPauseItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to a CIGI message, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOPauseMsg
Pause the selected CIGI message. Sending of the CIGI message can be resumed with a call to ccurAsyncIO_cigiIOResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_cigiIOPauseMsg(char *msgName )
Function arguments
msgName The name of the CIGI message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOResumeItemMsgName
Resume sending the selected CIGI message after it has been paused with a call to ccurAsyncIO_cigiIOPauseItemMsg.
The point on the message must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_cigiIOResumeItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an CIGI message. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOResumeMsg
Resume sending the selected CIGI message after the message has been paused with a call to ccurAsyncIO_cigiIOPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_cigiIOResumeMsg(char *msgName )
Function arguments
msgName The name of the CIGI message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOSetFIFOTxOnChange
Set/reset the FIFO/Queue message where the point is mapped to transmit on change. When Tx on change is set, the message is sent whenever its value changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_cigiIOSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change message flag.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_cigiIOSetFIFOTxOnChangeMsg
Set/reset the CIGI FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_cigiIOSetFIFOTxOnChangeMsg(char *msgName,int txOnChange)
Function arguments
msgName The name of the message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_cigiIOSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_cigiIOSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_cigiIOSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_cigiIOSetTxFIFOToScheduledMsg(char *msgName,int msRate)
Function arguments
msgName The name of the message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_cigiIOSetTxRate
Change the transmit rate of the CIGI message associated with the RTDB item.
The RTDB item must be mapped to a CIGI-IO output message.
Function prototype
int ccurAsyncIO_cigiIOSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTCIGIOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_cigiIOSetTxRateMsg
Change the transmit rate of an CIGI message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_cigiIOSetTxRateMsg(char *msgName,int msRate)
Function arguments
msgName The name of the CIGI message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_cigiIOSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_cigiIOSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_cigiIOSetTxScheduledToFIFOMsg
Switch the CIGI message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_cigiIOSetTxScheduledToFIFOMsg(char *msgName )
Function arguments
msgName The name of the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_cigiIOTXQueueNowMsg
Request that an CIGI message defined in FIFO queueing mode be sent now.
FIFO/Queue mode CIGI message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_cigiIOTXQueueNowMsg(char *msgName )
Function arguments
msgName The name of the CIGI message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_cigiIOTXQueueNowName
Request that an CIGI message defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple CIGI messages , all
of the them will be transmitted.
FIFO / Queue CIGI messages created in the configuration with TX on change set are only transmitted upon user request.
Function prototype
int ccurAsyncIO_cigiIOTXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the CIGI message we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the FDX output message associated with the RTDB item.
The RTDB item must be mapped to an FDX output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_fdxIOGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTiFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_fdxIOGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an FDX message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_fdxIOGetDefaultTxFlagsMsg(int boardNum, int groupId)
Function arguments
boardNum The board number . First board is 1.
groupId The group ID of the FDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_fdxIOGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the FDX output message associated with the RTDB item.
The RTDB item must be mapped to an FDX-IO output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_fdxIOGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_fdxIOGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an FDX message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_fdxIOGetDefaultTxRateMsg(int boardNum, int groupId)
Function arguments
boardNum The board number . First board is 1.
groupId The group ID of the FDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_fdxIOGetTxFlags
Return the transmit flags of the FDX output message associated with the RTDB item. The RTDB item must be mapped to an FDX output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_fdxIOGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_fdxIOGetTxFlagsMsg
Return the transmit rate of an FDX message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_fdxIOGetTxFlagsMsg(int boardNum, int groupId)
Function arguments
boardNum The board number . First board is 1.
groupId The group ID of the FDX message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_fdxIOGetTxRate
Return the transmit rate of the FDX output message associated with the RTDB item. The RTDB item must be mapped to an FDX output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_fdxIOGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_fdxIOGetTxRateMsg
Return the transmit rate of an FDX message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_fdxIOGetTxRateMsg(int boardNum, int groupId)
Function arguments
boardNum The board number . First board is 1.
groupId The group ID of the FDX message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_fdxIOPauseItemMsgName
Pause the FDX-IO message mapped to the specified RTDB item. Sending of the message can be resumed with a call to ccurAsyncIO_fdxIOResumeItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_fdxIOPauseItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to a FDX message, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOPauseMsg
Pause the selected FDX message. Sending of the FDX message can be resumed with a call to ccurAsyncIO_fdxIOResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_fdxIOPauseMsg(int boardNum, int groupId )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
groupId The group ID of the FDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOResumeItemMsgName
Resume sending the selected FDX message after it has been paused with a call to ccurAsyncIO_fdxIOPauseItemMsg.
The point on the message must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_fdxIOResumeItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an FDX message. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOResumeMsg
Resume sending the selected FDX message after the message has been paused with a call to ccurAsyncIO_fdxIOPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_fdxIOResumeMsg(int boardNum , int groupId)
Function arguments
boardNum integer with the board number where the message is defined . The first board is 1.
groupId The group ID of the FDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOSetFIFOTxOnChange
Set/reset the FIFO/Queue message where the point is mapped to transmit on change. When Tx on change is set, the message is sent whenever its value changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_fdxIOSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change message flag.
returns 0 On success.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_fdxIOSetFIFOTxOnChangeMsg
Set/reset the FDX FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_fdxIOSetFIFOTxOnChangeMsg(int boardNum, int groupId,int txOnChange)
Function arguments
boardNum The board number (starting at 1) where the FDX message is defined.
groupId The group ID of the FDX message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_fdxIOSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_fdxIOSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_fdxIOSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_fdxIOSetTxFIFOToScheduledMsg(int boardNum, int groupId,int msRate)
Function arguments
boardNum The board number (starting at 1) where the FDXIO message is defined.
groupId The group ID of the FDX message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_fdxIOSetTxRate
Change the transmit rate of the FDX message associated with the RTDB item.
The RTDB item must be mapped to a FDX-IO output message.
Function prototype
int ccurAsyncIO_fdxIOSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTFDXOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_fdxIOSetTxRateMsg
Change the transmit rate of an FDX message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_fdxIOSetTxRateMsg(int boardNum, int groupId,int msRate)
Function arguments
boardNum The board number . First board is 1.
groupId The group ID of the message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_fdxIOSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_fdxIOSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTFDXPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_fdxIOSetTxScheduledToFIFOMsg
Switch the FDX message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_fdxIOSetTxScheduledToFIFOMsg(int boardNum , int groupId)
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_fdxIOTXQueueNowMsg
Request that an FDX message defined in FIFO queueing mode be sent now.
FIFO/Queue mode FDX message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_fdxIOTXQueueNowMsg(int boardNum, int groupId)
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
groupId The group Id of the FDX message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_fdxIOTXQueueNowName
Request that an FDX message defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple FDX messages , all
of the them will be transmitted.
FIFO / Queue FDX messages created in the configuration with TX on change set are only transmitted upon user request.
Function prototype
int ccurAsyncIO_fdxIOTXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the FDX message we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_linGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the LIN output message associated with the RTDB item. The RTDB item must be mapped to a LIN output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_linGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_linGetDefaultTxFlagsLINId
Return the default transmit rate as configured in the RTDB of an LIN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_linGetDefaultTxFlagsLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number . First board is 1.
netNum The net number.
canId The LIN id.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_linGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the LIN output message associated with the RTDB item.
The RTDB item must be mapped to a LIN output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_linGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_linGetDefaultTxRateLINId
Return the default transmit rate as configured in the RTDB of a LIN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_linGetDefaultTxRateLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number . First board is 1.
netNum The net number.
canId The LIN id.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_linGetLastRXIntervalLINId
Returns the interval in micro seconds between the last 2 updates the specified label .
It is used to check that the transmitting device is transmitting at a regular interval.
Function prototype
int ccurAsyncIO_linGetLastRXIntervalLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId integer with the board Id. Either BABY_LIN
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
canId The LINid.
returns The value in micro seconds or < 0 if error.
|
ccurAsyncIO_linGetTimeSinceLastRXLINId
Returns the number of micro seconds elapsed since the specified LIN id was last received .
Function prototype
int ccurAsyncIO_linGetTimeSinceLastRXLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId integer with the board Id. Either BABY_LIN
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
canId The LINid.
returns The number of micro seconds if > 0.
< 0 RTDB_POINTNOTFOUND if the label cannot be found.
|
ccurAsyncIO_linGetTxFlags
Return the transmit flags of the LIN output message associated with the RTDB item. The RTDB item must be mapped to an LIN output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_linGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_linGetTxFlagsLINId
Return the transmit rate of an LIN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_linGetTxFlagsLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number . First board is 1.
netNum The net number.
canId The LIN id.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_linGetTxRate
Return the transmit rate of the LIN output message associated with the RTDB item. The RTDB item must be mapped to a LIN output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_linGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_linGetTxRateLINId
Return the transmit rate of a LIN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_linGetTxRateLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number . First board is 1.
netNum The net number.
canId The LIN id.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_linPauseLINId
Pause the selected LIN message. Sending of the LIN message can be resumed with a call to ccurAsyncIO_linResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_linPauseLINId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
canId The LIN id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_linResumeLINId
Resume sending the selected LIN message after the message has been paused with a call to ccurAsyncIO_linPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_linResumeLINId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum integer with the board number where the message is defined . The first board is 1.
netNum integer with the net number where the LIN id is defined .
canId The LIN id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_linSetFIFOTxOnChange
Set/reset the FIFO LIN id where the point is mapped to transmit on change. When Tx on change is set, the LIN id is sent whenever its value changed.
When Tx on change is reset, the LIN message is only by user request.
Function prototype
int ccurAsyncIO_linSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name ofi the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change LIN id flag.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTLINOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_linSetFIFOTxOnChangeLINId
Set/reset the FIFO LIN id to transmit on change. When Tx on change is set, the LIN id is sent whenever its value changed.
When Tx on change is reset, the LIN message is only by user request.
Function prototype
int ccurAsyncIO_linSetFIFOTxOnChangeLINId(int boardId,int boardNum,int netNum,int canId,int txOnChange )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum integer with the board number where the LIN Id is defined . The first board is 1.
netNum integer with the net number where the LIN Id is defined .
canId integer with the LIN Id to be sent .
txOnChange Boolean indicating whether to set or reset the Tx on change LIN id flag.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTLINOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_linSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_linSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_linSetTxFIFOToScheduledLINId
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_linSetTxFIFOToScheduledLINId(int boardId,int boardNum,int netNum,int canId,int msRate)
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number (starting at 1) where the LIN message is defined.
netNum the net number on which the message is defined.
canId The LIN id.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTLINPOINT, SCRIPT_NOTLINOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_linSetTxRate
Change the transmit rate of the LIN message associated with the RTDB item. The RTDB item must be mapped to a LIN output message.
Function prototype
int ccurAsyncIO_linSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTLINPOINT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_linSetTxRateLINId
Change the transmit rate of a LIN message by specifying the board number , net number and canId .
Function prototype
int ccurAsyncIO_linSetTxRateLINId(int boardId,int boardNum,int netNum,int canId ,int msRate)
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number . First board is 1.
netNum The net number.
canId The LINid.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_linSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_linSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTLINPOINT, SCRIPT_NOTLINOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_linSetTxScheduledToFIFOLINId
Switch the LIN message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_linSetTxScheduledToFIFOLINId(int boardId,int boardNum,int netNum,int canId)
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum The board number (starting at 1) where the LIN message is defined.
netNum the net number on which the message is defined.
canId The LIN id.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_linTXQueueNowLINId
Request that the value of label defined in FIFO queueing mode be sent now.
FIFO mode labels are only transmitted upon user request.
Function prototype
int ccurAsyncIO_linTXQueueNowLINId(int boardId,int boardNum,int netNum,int canId )
Function arguments
boardId The board type where the LIN is defined. I.e. one of BABY_LIN(72) .
boardNum integer with the board number where the LIN Id is defined . The first board is 1.
netNum integer with the net number where the LIN Id is defined .
canId integer with the LIN Id to be sent .
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_linTXQueueNowName
Request that the value of LIN Id defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple LIN Id's , all
of the them will be transmitted.
FIFO mode LIN Id with IOFL_TXONCHANGE flag are only transmitted upon user request.
Function prototype
int ccurAsyncIO_linTXQueueNowName(char *pointName )
Function arguments
pointName Name of the RTDB item mapped to the label we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the NET output message associated with the RTDB item.
The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_netIOGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTiNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_netIOGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_netIOGetDefaultTxFlagsMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_netIOGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the NET output message associated with the RTDB item.
The RTDB item must be mapped to an NET-IO output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_netIOGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_netIOGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_netIOGetDefaultTxRateMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_netIOGetTxFlags
Return the transmit flags of the NET output message associated with the RTDB item. The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_netIOGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_netIOGetTxFlagsMsg
Return the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_netIOGetTxFlagsMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_netIOGetTxRate
Return the transmit rate of the NET output message associated with the RTDB item. The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_netIOGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_netIOGetTxRateMsg
Return the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_netIOGetTxRateMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_netIOPauseItemMsgName
Pause the NET-IO message mapped to the specified RTDB item. Sending of the message can be resumed with a call to ccurAsyncIO_netIOResumeItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_netIOPauseItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to a NET message, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOPauseMsg
Pause the selected NET message. Sending of the NET message can be resumed with a call to ccurAsyncIO_netIOResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_netIOPauseMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOResumeItemMsgName
Resume sending the selected NET message after it has been paused with a call to ccurAsyncIO_netIOPauseItemMsg.
The point on the message must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_netIOResumeItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an NET message. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOResumeMsg
Resume sending the selected NET message after the message has been paused with a call to ccurAsyncIO_netIOPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_netIOResumeMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the message is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOSetDestPortIP
Change the destination port and IP for an output NETIO message. The existing connection is closed and will be reestablished on the new port.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_netIOSetDestPortIP(int boardNum,char *msgName ,int destPort,int destIP)
Function arguments
boardNum The board number (starting at 1) where the NET message is defined.
msgName The name of the message.
destPort The new destination port for the message. Set destPort = 0 to keep the port defined in the original message.
destIP The new destination IP address for the message. Set destIP = 0 to keep the IP defined in the original message.
To set the to IP 192.168.1.10 , pass the integer as follows (192 << 24) + (168 << 16) + (1<<8) + 10
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_netIOSetFIFOTxOnChange
Set/reset the FIFO/Queue message where the point is mapped to transmit on change. When Tx on change is set, the message is sent whenever its value changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_netIOSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change message flag.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_netIOSetFIFOTxOnChangeMsg
Set/reset the NET FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_netIOSetFIFOTxOnChangeMsg(int boardNum,char *msgName,int txOnChange)
Function arguments
boardNum The board number (starting at 1) where the NET message is defined.
msgName The name of the message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_netIOSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_netIOSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_netIOSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_netIOSetTxFIFOToScheduledMsg(int boardNum,char *msgName,int msRate)
Function arguments
boardNum The board number (starting at 1) where the NETIO message is defined.
msgName The name of the message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_netIOSetTxRate
Change the transmit rate of the NET message associated with the RTDB item.
The RTDB item must be mapped to a NET-IO output message.
Function prototype
int ccurAsyncIO_netIOSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_netIOSetTxRateMsg
Change the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_netIOSetTxRateMsg(int boardNum,char *msgName,int msRate)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_netIOSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_netIOSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_netIOSetTxScheduledToFIFOMsg
Switch the NET message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_netIOSetTxScheduledToFIFOMsg(int boardNum,char *msgName )
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
msgName The name of the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_netIOTXQueueNowMsg
Request that an NET message defined in FIFO queueing mode be sent now.
FIFO/Queue mode NET message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_netIOTXQueueNowMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_netIOTXQueueNowName
Request that an NET message defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple NET messages , all
of the them will be transmitted.
FIFO / Queue NET messages created in the configuration with TX on change set are only transmitted upon user request.
Function prototype
int ccurAsyncIO_netIOTXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the NET message we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_sentGetLastRXIntervalSENTId
Returns the interval in micro seconds between the last 2 updates the specified label .
It is used to check that the transmitting device is transmitting at a regular interval.
Function prototype
int ccurAsyncIO_sentGetLastRXIntervalSENTId(int boardId,int boardNum,int channelNum,int sentId )
Function arguments
boardId integer with the board Id. Either CP_SENT or CP_FPGA_ArV (77) or CP_CMFIO(104)
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
sentId The SENTId.
returns The value in micro seconds or < 0 if error.
|
ccurAsyncIO_sentGetRxCountSENTId
Get the number of messages received for the selected SENT id.
Function prototype
int ccurAsyncIO_sentGetRxCountSENTId(int boardId,int boardNum,int channelNum,int sentId)
Function arguments
boardId The board type where the SENT is defined. I.e. one of CP_SENT(80) or CP_FPGA_ArV (77) or CP_CMFIO (104).
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
sentId The SENT id as defined in the RTDB configuration.
returns >= 0 The number of message received.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_sentGetTimeSinceLastRXSENTId
Returns the number of micro seconds elapsed since the specified SENT id was last received .
Function prototype
int ccurAsyncIO_sentGetTimeSinceLastRXSENTId(int boardId,int boardNum,int channelNum,int sentId )
Function arguments
boardId integer with the board Id. Either CP_SENT or CP_FPGA_ArV (77) or CP_CMFIO (104)
boardNum The board number (first board is 0) where the label is defined.
netNum The board net number number (0-3).
sentId The SENTId.
returns The number of micro seconds if > 0.
< 0 RTDB_POINTNOTFOUND if the label cannot be found.
|
ccurAsyncIO_sentGetTxCountSENTId
Get the number of messages transmitted for the selected SENT id.
Function prototype
int ccurAsyncIO_sentGetTxCountSENTId(int boardId,int boardNum,int channelNum,int sentId)
Function arguments
boardId The board type where the SENT id is defined. I.e. one of CP_SENT(80) or CP_FPGA_ArV (77) or CP_CMFIO (104)
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
sentId The SENT id as defined in the RTDB configuration.
returns >= 0 The number of message transmitted.
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_sentGetTxFlags
Return the transmit flags of the SENT output message associated with the RTDB item. The RTDB item must be mapped to an SENT output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_sentGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTCANPOINT, SCRIPT_NOTCANOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_sentGetTxFlagsSENTId
Return the transmit flags of an SENT message by specifying the board number , net number and sentId .
Function prototype
int ccurAsyncIO_sentGetTxFlagsSENTId(int boardId,int boardNum,int channelNum,int sentId )
Function arguments
boardId The board type where the SENT id is defined. I.e. one of CP_SENT(80) or CP_FPGA_ArV (77) or CP_CMFIO (104)
boardNum The board number . First board is 1.
netNum The net number.
sentId The SENT id.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_sentPauseSENTId
Pause the selected SENT message. Sending of the SENT message can be resumed with a call to ccurAsyncIO_sentResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_sentPauseSENTId(int boardId,int boardNum,int channelNum,int sentId)
Function arguments
boardId The board type where the SENT id is defined. I.e. one of CP_SENT(15) or CANIO_PEAK (21).
boardNum integer with the board number where the label is defined . The first board is 1.
netNum integer with the net number where the message is defined .
sentId The SENT id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_sentResumeSENTId
Resume sending the selected SENT message after the message has been paused with a call to ccurAsyncIO_sentPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_sentResumeSENTId(int boardId,int boardNum,int channelNum,int sentId)
Function arguments
boardId The board type where the SENT id is defined. I.e. one of CP_SENT(80) or CP_FPGA_ArV (77) or CP_CMFIO (104).
boardNum integer with the board number where the message is defined . The first board is 1.
channelNum integer with the net number where the SENT id is defined .
sentId The SENT id as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOGetDefaultTxFlags
Return the default transmit flags as configured in the RTDB of the NET output message associated with the RTDB item.
The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_udpIOGetDefaultTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTiNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_udpIOGetDefaultTxFlagsMsg
Return the default transmit rate as configured in the RTDB of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_udpIOGetDefaultTxFlagsMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_udpIOGetDefaultTxRate
Return the default transmit rate as configured in the RTDB of the NET output message associated with the RTDB item.
The RTDB item must be mapped to an NET-IO output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_udpIOGetDefaultTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_udpIOGetDefaultTxRateMsg
Return the default transmit rate as configured in the RTDB of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_udpIOGetDefaultTxRateMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_udpIOGetTxFlags
Return the transmit flags of the NET output message associated with the RTDB item. The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX flags for the first mapping is returned.
Function prototype
int ccurAsyncIO_udpIOGetTxFlags(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the TX flags .
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO,MSGIO_TXONCHANGE,MSGIO_PAUSED.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND .
|
ccurAsyncIO_udpIOGetTxFlagsMsg
Return the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_udpIOGetTxFlagsMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit flags as a combination of MSGIO_SCHED, MSGIO_FIFO, MSGIO_TXONCHANGE, MSGIO_PAUSED.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_udpIOGetTxRate
Return the transmit rate of the NET output message associated with the RTDB item. The RTDB item must be mapped to an NET output message.
If the item is mapped to more than one output message, the TX rate for the first mapping is returned.
Function prototype
int ccurAsyncIO_udpIOGetTxRate(char *pointName )
Function arguments
pointName The name of the RTDB item for which we want the transmit rate.
returns The transmit rate in milliseconds.
< 0 SCRIPT_NOTAFDXPOINT, SCCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND, SCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_udpIOGetTxRateMsg
Return the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_udpIOGetTxRateMsg(int boardNum,char *msgName)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
returns The transmit rate in milliseconds.
< 0 When an error occurred and the label could not be found.
|
ccurAsyncIO_udpIOPauseItemMsgName
Pause the NET-IO message mapped to the specified RTDB item. Sending of the message can be resumed with a call to ccurAsyncIO_udpIOResumeItemMsg.
The label must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_udpIOPauseItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to a NET message, this call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOPauseMsg
Pause the selected NET message. Sending of the NET message can be resumed with a call to ccurAsyncIO_udpIOResumeMsg.
The message must be defined as a scheduled/Sample message for this to work,
Function prototype
int ccurAsyncIO_udpIOPauseMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOResumeItemMsgName
Resume sending the selected NET message after it has been paused with a call to ccurAsyncIO_udpIOPauseItemMsg.
The point on the message must be defined as a schedule label for this to work.
Function prototype
int ccurAsyncIO_udpIOResumeItemMsgName(char *pointName )
Function arguments
pointName Name of the RTDB item which is mapped to the message. If the point is not mapped to an NET message. This call returns an error.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOResumeMsg
Resume sending the selected NET message after the message has been paused with a call to ccurAsyncIO_udpIOPauseMsg.
The message must be defined as a schedule/Sample message for this to work.
Function prototype
int ccurAsyncIO_udpIOResumeMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the message is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOSetFIFOTxOnChange
Set/reset the FIFO/Queue message where the point is mapped to transmit on change. When Tx on change is set, the message is sent whenever its value changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_udpIOSetFIFOTxOnChange(char *pointName,int txOnChange)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
txOnChange Boolean indicating whether to set or reset the Tx on change message flag.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_udpIOSetFIFOTxOnChangeMsg
Set/reset the NET FIFO message transmit on change state. When Tx on change is set, the message is sent whenever its content changes.
When Tx on change is reset, the message is only sent by user request.
Function prototype
int ccurAsyncIO_udpIOSetFIFOTxOnChangeMsg(int boardNum,char *msgName,int txOnChange)
Function arguments
boardNum The board number (starting at 1) where the NET message is defined.
msgName The name of the message.
txOnChange Boolean indicating whether to set or reset the Tx on change state on the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_udpIOSetTxFIFOToScheduled
Switch the message where the point is mapped from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
Function prototype
int ccurAsyncIO_udpIOSetTxFIFOToScheduled(char *pointName,int msRate)
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
configuring the RTDB, the message does NOT have an original scheduled rate and so the msRate must be supplied by the user the first time the call is used on the given item.
returns 0 On success.
< 0 SCRIPT_NOTARINCPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_udpIOSetTxFIFOToScheduledMsg
Switch the message from FIFO to scheduled transmission mode . If the message is already in scheduled mode, nothing happens and the call just
returns with 0 error code. The previously used scheduled rate for the message can either be restored by passing -1 as the new transmission rate or
set to the new value passed in the msRate argument.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_udpIOSetTxFIFOToScheduledMsg(int boardNum,char *msgName,int msRate)
Function arguments
boardNum The board number (starting at 1) where the NETIO message is defined.
msgName The name of the message.
msRate The new transmit rate in milliseconds or -1 to restore the previously save rate. Be aware that if the message was initially setup as a FIFO/Queue message when
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_udpIOSetTxRate
Change the transmit rate of the NET message associated with the RTDB item.
The RTDB item must be mapped to a NET-IO output message.
Function prototype
int ccurAsyncIO_udpIOSetTxRate(char *pointName ,int msRate)
Function arguments
pointName The name of the RTDB item for which we want to change the transmit rate. Be aware that this will not change the default value for this variable in the RTDB.
msRate The transmit rate in milliseconds.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTNETOUTPUT, RTDB_POINTNOTFOUND, CSCRIPT_BADARINCTXRATE.
|
ccurAsyncIO_udpIOSetTxRateMsg
Change the transmit rate of an NET message by specifying the board number and message name .
Function prototype
int ccurAsyncIO_udpIOSetTxRateMsg(int boardNum,char *msgName,int msRate)
Function arguments
boardNum The board number . First board is 1.
msgName The name of the NET message.
msRate The transmit rate in milliseconds.
returns N/A
|
ccurAsyncIO_udpIOSetTxScheduledToFIFO
Switch the message where the point is mapped from scheduled transmission mode to FIFO mode. If the message is already in FIFO mode, nothing happens and the call just
returns with 0 error code. The current scheduled rate for the message is saved so that it can be restored when the message is switched back to scheduled mode.
Function prototype
int ccurAsyncIO_udpIOSetTxScheduledToFIFO(char *pointName )
Function arguments
pointName Name of the RTDB item for which we want to change the transmission mode.
returns 0 On success.
< 0 SCRIPT_NOTNETPOINT, SCRIPT_NOTAFDXOUTPUT, RTDB_POINTNOTFOUND.
|
ccurAsyncIO_udpIOSetTxScheduledToFIFOMsg
Switch the NET message from scheduled transmission mode to FIFO/Queue mode.
If the message is already in FIFO mode, nothing happens and the call just returns with 0 error code.
Function prototype
int ccurAsyncIO_udpIOSetTxScheduledToFIFOMsg(int boardNum,char *msgName )
Function arguments
boardNum The board number (starting at 1) where the AFDX message is defined.
msgName The name of the message.
returns 0 On success.
< 0 RTDB_POINTNOTFOUND if the message cannot be found.
|
ccurAsyncIO_udpIOTXQueueNowMsg
Request that an NET message defined in FIFO queueing mode be sent now.
FIFO/Queue mode NET message are only transmitted upon user request.
Function prototype
int ccurAsyncIO_udpIOTXQueueNowMsg(int boardNum,char *msgName )
Function arguments
boardNum integer with the board number where the label is defined . The first board is 1.
msgName The name of the NET message as defined in the RTDB configuration.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurAsyncIO_udpIOTXQueueNowName
Request that an NET message defined in FIFO queueing mode be sent now. If the item specified is mapped to multiple NET messages , all
of the them will be transmitted.
FIFO / Queue NET messages created in the configuration with TX on change set are only transmitted upon user request.
Function prototype
int ccurAsyncIO_udpIOTXQueueNowName(char *pointName)
Function arguments
pointName Name of the RTDB item mapped to the NET message we want to transmit.
returns 0 on Success
< 0 RTDB_POINTNOTFOUND if error.
|
ccurEB5100_commitFrame
Commit the Flexray frame whose index is given.
Function prototype
int ccurEB5100_commitFrame(int boardNum,int frameIndex)
Function arguments
boardNum The board number on which to commit the frame . The first board in the system is board number 1.
frameIndex The index of the frame to commit.
returns 0 on Success
< 0 if the EB5100 asynchronous output queue is full.
|
ccurEB5100_disableSendFrame
Disable sending of the Flexray frame whose index is given and for a number of repetitions.
Function prototype
int ccurEB5100_disableSendFrame(int boardNum,int frameIndex,int frameType,int nRepetitions)
Function arguments
boardNum The board number on which to commit the frame . The first board in the system is board number 1.
frameIndex The index of the frame to enable.
frameType The type of frame so send: 0 to send a NULL frame instead , 1 to remove the frame from the bus altogether.
nRepetitions The number of cycles to disable the frame. A value of 0 means repeat forever.
returns 0 on Success
< 0 if the EB5100 asynchronous output queue is full.
|
ccurEB5100_enableSendFrame
Enable sending of the Flexray frame whose index is given.
Function prototype
int ccurEB5100_enableSendFrame(int boardNum,int frameIndex)
Function arguments
boardNum The board number on which to commit the frame . The first board in the system is board number 1.
frameIndex The index of the frame to enable.
returns 0 on Success
< 0 if the EB5100 asynchronous output queue is full.
|
ccurEB5100_getLastError
Retrieve last error from EB5100 firmware. The error string is place in the RTDB _EB_ErrorString variable
Function prototype
int ccurEB5100_getLastError(int boardNum)
Function arguments
boardNum The board number on which to commit the frame . The first board in the system is board number 1.
returns 0 on Success
< 0 if the EB5100 asynchronous output queue is full.
|
ccurEB5100_startCommunication
Start the FlexRay communication on the specified eb5100 board.
Function prototype
int ccurEB5100_startCommunication(int boardNum)
Function arguments
boardNum the board number on which to start the communication. The first board in the system is board number 1.
returns 0 on Success
< 0 if the EB5100 asynchronous output queueis full.
|
ccurEB5100_stopCommunication
Stop the FlexRay communication on the specified eb5100 board.
Function prototype
int ccurEB5100_stopCommunication(int boardNum)
Function arguments
boardNum the board number on which to start the communication. The first board in the system is board number 1.
returns 0 on Success
< 0 if the EB5100 asynchronous output queue is full.
|
ccurGen_addAsamGenerator
Attach an ASAM wave form generator to an RTDB point value.
A test must be running before you can create and start a signal generator.
Function prototype
int ccurGen_addAsamGenerator(char *pointName, char *asamFile)
Function arguments
pointName The name of the RTDB item to be driven.
asamFile The name of the ASAM signal definition file.
returns > 0 The generator number on Sucess.
< 0 On Failure. Error can be any of the RTDB or GEN_xx failure code. See also: simerrors.h
|
ccurGen_addGenerator
Attach a wave form generator to a RTDB point value for a specified duration or terminate with a user specified callback.
A test must be running before you can create and start a signal generator.
\warning This function require long execution time as it generates an internal buffer of a one cycle wave used for DDS wave generation.
Function prototype
int ccurGen_addGenerator(char *pointName,int endConditionType, int sigtype,float freq,float ampl,float phase,float offset, float duty,float noise,double duration, void *userArg)
Function arguments
pointName The name of the RTDB item to assign value to.
endConditionType One of TDL_SiggenEndCondition. Either terminate when user specified time has expired or when the user supplied callback routine returns true;
sigtype One of SigType i.e. SIG_TYPE_SINE, SIG_TYPE_SQUARE, SIG_TYPE_TRIANGLE, SIG_TYPE_SAWTOOTH, SIG_TYPE_NOISE but NOT SIG_TYPE_RAMP reserved for ramp only.
freq The frequency in Hz for the signal generator.
amplitude The amplitude in Engineering for the generator.
phase The phase in degree for the generator.
offset The offset in engineering units for the generator.
duty The duty cycle in % (0 to 100 %) for the generator.
noise Additional white component to add to the signal generator.
duration The duration in seconds . Use -1 to run forever until the test is stopped.
userArg Pointer to pass to the user callback routine at each call. Callback is not supported at this time.
returns > 0 The generator number on Sucess.
< 0 On Failure. Error can be any of the RTDB or GEN_xx failure code. See also: simerrors.h
|
ccurGen_addSegmentGenerator
Attach an segemented wave form generator to an RTDB point value.
This is similar to a ASAM generator but the signal generator file is In the SigGenerators directory.
A test must be running before you can create and start a signal generator.
Function prototype
int ccurGen_addSegmentGenerator(char *pointName, char *asamFile,int repeat)
Function arguments
pointName The name of the RTDB item to be driven.
sigName The name of the generator ; i.e. 'sig1', 'mysig', etc..
repeat The number of time to repeat the segment when generating data.
returns > 0 The generator number on Sucess.
< 0 On Failure. Error can be any of the RTDB or GEN_xx failure code. See also: simerrors.h
|
ccurGen_rampRate
Ramp up/down a RTDB point value for a specified duration.
The function will keep running for the duration specified by the call.
Function prototype
int ccurGen_rampRate(char *pointName,double duration,double rate,int initCondition,double initialValue)
Function arguments
pointName The name of the RTDB item to assign value to.
duration The duration in seconds. Must be > 0.
rate The rate in Units/Seconds at which to ram the value of the item up or down.
initCondition The initial value type for the ramp. See also: GEN_SiggenInitValue .
initialValue This is the initial value for the point when initCondition is GEN_SIGGENINIT_USER.
returns > 0 The generator number on success.
< 0 On Failure. Error can be any of the RTDB or TDL failure code. See also: simerrors.h
|
ccurGen_rampToValue
Ramp up/down a RTDB point value to a specified value.
The function will keep running until the end value is attained.
A test must be running before you can create and start a ram signal.
Function prototype
int ccurGen_rampToValue(char *pointName,double endValue,double rate, int initCondition,double initialValue)
Function arguments
pointName The name of the RTDB item to assign value to.
endValue The target end value.
rate The rate in Units/Seconds at which to ramp the value of the item up or down.
initCondition The initial value type for the ramp. See also: GEN_SiggenInitValue .
initialValue This is the initial value for the point when initCondition is GEN_SIGGENINIT_USER.
returns > 0 The generator number on success.
< 0 On Failure. Error can be any of the RTDB or TDL failure code. See also: simerrors.h
|
ccurGen_startAllGenerators Start all the generators that have been defined. This does not start generators that are appended. |
ccurRTDB_formCapture
Capture values of RTDB items and save to a file. The set of items is defined by the RTViewer form name.
Function prototype
int ccurRTDB_formCapture(char *formName,char *nameTemplate,int captureType,double period,int runCount)
Function arguments
formName The name of the form that defines the items to be captured.
nameTemplate A template to form the name of the capture file. The template can contains predefined tokens such as:
<li> $testname
<li> $sessionname
<li> $formname
<li> $date
<li> $time
<li> $framecount
<li> $seqnum
captureType Define the format to write the capture file: one of (0 == CSV, 1 == Initial Condition, 2 == RTForm, 3 == MAT file)
period The period in seconds when capturing multiple records, only apply for CSV.
runCount The number of records to capture , only apply for CSV.
|
ccurRTDB_formImport
Import the values defined in a form into the RTDB of a running test.
Function prototype
int ccurRTDB_formImport(char *formName,char inputsOnly)
Function arguments
formName The name of the form.
inputsOnly If non-zero, only set the values of items defined as input
|
ccurRTDB_getAlternateValueDouble
Return the alternate value of an RTDB item as a 'C' double.
If the RTDB item is an array, this routine always returns 0. Use ccurRTDB_getAlternateValue for
non scalar RTDB items.
Function prototype
int ccurRTDB_getAlternateValueDouble(char *pointName)
Function arguments
pointName The name of the RTDB item.
returns The alternate value of the RTDB item or 0 if the item is a string variable.
|
ccurRTDB_getCVTValueDouble
Return the CVT value of an RTDB item as a 'C' double.
If the RTDB item is an array, this routine always returns 0. Use ccurRTDB_getCVTValueP for
non scalar RTDB items.
Function prototype
int ccurRTDB_getCVTValueDouble(char *pointName)
Function arguments
pointName The name of the RTDB item.
returns The CVT value of the RTDB item or 0 if the item is a string variable.
|
ccurRTDB_getCurrentValueDouble
Return the current value of an RTDB item as a 'C' double.
When the RTDB item is non-scalar, this routines always returns 0.
The current value is always the CVT value for input points whereas for output
points, the current value is the alternate value when either the alternate or operator flags is set.
If the item is not defined in the CVT. The alternate value is returned.
If it is an INPUT point, the value comes from the CVT since when overridden the I/O value goes into the alternate value.
If it is OUTPUT point, it comes from the alternate value if the CVT value has been overridden (RTDBFL_ALTVALUE | RTDBFL_OPERATOR is set) and the
alternate is the value used to do the physical output.
Function prototype
int ccurRTDB_getCurrentValueDouble(char *pointName)
Function arguments
pointName The name of the RTDB item.
returns The CVT value of the RTDB item or 0 if the item is a string variable.
|
ccurRTDB_resetToDefault
Reset all RTDB items in the database to their default value.
\warning This function goes through all entries in the RTDB item hash table and can be very slow depending
on the size of your RTDB. The hash table is over dimensioned with respect to the total number of items it can hold
in order to minimize collisions and increase determinism on item searches.
The maximum number of items in the RTDB is determined by cfgsrv at startup. The default is 25000 items.
and can be modified by passing -p number_of_items on the command line when starting cfgsrv.
The items that have the meta flags METAFL_HASDEFAULT are reset to the default value. The other items are set to 0.
The items real-time flags is reset to 0.
returns 0
|
ccurRTDB_setAlternateFlag
Set/Reset the Item Alternate flag.
Function prototype
int ccurRTDB_setAlternateFlag(char *pointName,int enable)
Function arguments
pointName The name of the RTDB item.
enable True to set the flag , false to reset the flag
returns 0 If set successfully.
returns < 0 RTDB_POINTNOTFOUND On failure.
|
ccurRTDB_setAlternateValueDouble
Set the Alternate value of an RTDB item. The value is passed to the call as a 'C' double.
If the RTDB item is an array, this routine returns immediately. Use ccurRTDB_setAlternateValue to set the value for non scalar items.
Function prototype
int ccurRTDB_setAlternateValueDouble(char *pointName,double varValue)
Function arguments
pointName The name of RTDB item.
varValue The value to be set.
|
ccurRTDB_setCVTValueDouble
Set the CVT value of an RTDB item. The value is passed to the call as a 'C' double.
If the RTDB item is an array, this routine returns immediately. Use ccurRTDB_setCVTValue to set the value for non scalar items.
Function prototype
int ccurRTDB_setCVTValueDouble(char *pointName,double varValue)
Function arguments
pointName The name of the RTDB item.
varValue The value to be set.
|
ccurRTDB_setCurrentValueDouble
Set the current value of an RTDB item. The value is passed to the call as a 'C' double.
If the RTDB item is an array, this routine returns immediately. Use ccurRTDB_setCurrentValue to set the value for non scalar items.
The current value is always the CVT value for input points whereas for output
points, the current value is the alternate value when either the alternate or operator flags is set.
If the item is not defined in the CVT. It will be stored in the alternate value.
If it is an INPUT point, it goes in the CVT since when overridden the I/O value goes in the alternate value.
If it is OUTPUT point, it goes in the alternate value if the CVT value has been overridden (RTDBFL_ALTVALUE is set) and
alternate is the value used to do the physical output.
Function prototype
int ccurRTDB_setCurrentValueDouble(char *pointName,double varValue)
Function arguments
pointName The name of the RTDB item.
varValue The value to be set.
|
ccurRTDB_setLoggingEnable
Toggle the dynamic logging flag for the specified point name.
This flag is automatically toggled at initialization for all points which are to be logged. I.e. those
that have the logging flag on. See also: ccurRTDB_setLoggingFlag.
Also, this flag cannot be turned off during the initialization phase of a user script since
the data logger waits for the script initialization routine (ccurCScript_init) to complete before
setting the METAFL_ARCHIVEENABLE bit on.
This call will also turn the RTDBFL_ARCHIVEPAUSED real-time flags that is recorded by the data logger on/off so
that the data extraction routine knows whether data logging for the specific item has been paused.
Function prototype
int ccurRTDB_setLoggingEnable(char *pointName,char enable)
Function arguments
pointName The name of the RTDB item on which we set the logging flag.
enable If true, the point values will be logged. When false, logging is disabled.
returns 0 On success.
returns -1 RTDB_POINTNOTFOUND On failure .
|
ccurRTDB_setOperatorFlag
Set/Reset the Item operator flag.
Function prototype
int ccurRTDB_setOperatorFlag(char *pointName,int enable)
Function arguments
pointName The name of the RTDB item.
enable True to set the flag , false to reset the flag
returns 0 If set successfully.
returns < 0 RTDB_POINTNOTFOUND On failure.
|
ccurRTDB_snapshot Take a snapshot of the RTDB loaded in memory. Group of items can be selected. See Control Center documentation for more info |
ccurRTDB_stopCircularLogger Stop the crash loop circular logger. Once it has been stopped, this circular logger cannot be restarted. |
ccurRTDB_takeSpareItem
Rename a spare RTDB item in the RTDB to a new name and take it out of the spare item table.
Function prototype
int ccurRTDB_takeSpareItem(char *newName,int pointType,int cvtType)
Function arguments
newName The name to use for the new item.
pointType The point type defining the type of point to take .
cvtType The CVT type for this new item.
returns >=i 0 When successful. This routine only fails when the spare item table if full.
returns < 0 On failure ( RTDB_POINTEXISTS when the newName already exists in the RTDB RTDB_NOSPAREITEM when no more spare items of the specified type are available. )
|
ccurRTDB_writeStdOut
Write data to the script pseudo standard out.
Function prototype
int ccurRTDB_writeStdOut(char *str)
Function arguments
str Character buffer where to output.
returns Always returns 0
|
ccurSched_nonRT Tell the scheduler that we want to run non real-time. In non RT mode, the scheduled processes do not cause overrruns. |
ccurSched_pause Pause the execution of the scheduler. This is used internally when stepping through execution cycles. |
ccurSched_step
Step the execution of the scheduler through nFrames frames of execution.
Function prototype
int ccurSched_step(int nFrames)
Function arguments
nFrames The number of frames to step the execution through.
|
Connect to the RPC server running on the host system given by 'hostName'.
hostName is a string with the name of the real-time host.
When already connected this funtion simply returns 0.
The return code has the following meaning:
0: success.
not 0: error (see simwbClient.strerror(code)).
|
Disconnect from the RPC server running on the real-time host. This routine always succeeds, and has no return value. |
Return a string representation of the message text associated with the SimWB integer error 'code'. If 'code' is not an SimWB error code, then it is assume to be an errno value, and the message text for that is returned. * NOTE: multi-line message text is seperated with a newline (\n) character. |
| Trees | Indices | Help |
|
|---|
| (c) Concurrent Real-Time | http://www.concurrent-rt.com |