Channel Initialisation
Overview
Analog I/O module channel initialisation functions This group defines all functions to initialise analog I/O channels properly.
Collaboration diagram for Channel Initialisation:
Functions | |
| long | LCAIO_GetInChanHandle (unsigned char Index, dev_hdl *pInChanHdl) |
| Get analog input channel handle by its index. More... | |
| long | LCAIO_GetNoOfInputChannels () |
| Query number of available analog input channels. More... | |
| long | LCAIO_GetNoOfOutputChannels () |
| Query number of available analog output channels. More... | |
| long | LCAIO_GetOutChanHandle (unsigned char Index, dev_hdl *pOutChanHdl) |
| Get analog out channel handle by its index. More... | |
| long | LCAIO_LookupInChanByName (const char *pChannelName, dev_hdl *pInChanHdl) |
| Lookup for an analog input channel by its name. More... | |
| long | LCAIO_LookupOutChanByName (const char *pChannelName, dev_hdl *pOutChanHdl) |
| Lookup for an analog output channel by its name. More... | |
Function Documentation
| long LCAIO_GetInChanHandle | ( | unsigned char | Index, |
| dev_hdl * | pInChanHdl | ||
| ) |
Get analog input channel handle by its index.
- Parameters
-
[in] Index Index into list of available analog input channels [out] pInChanHdl Handle to input channel or 0 if the given index is out of range
- Return values
-
-ERR_PARAM_RANGE If the given device index is out of range ERR_NOERR indicates success
- Examples:
- capi_pressure_control_test.cpp.
| long LCAIO_GetNoOfInputChannels | ( | ) |
Query number of available analog input channels.
- Return values
-
>= 0 Number of available analog input channels < 0 Error code
| long LCAIO_GetNoOfOutputChannels | ( | ) |
Query number of available analog output channels.
- Return values
-
>= 0 Number of available analog output channels < 0 Error code
| long LCAIO_GetOutChanHandle | ( | unsigned char | Index, |
| dev_hdl * | pOutChanHdl | ||
| ) |
Get analog out channel handle by its index.
- Parameters
-
[in] Index Index into list of available analog out channels [out] pOutChanHdl Handle to output channel or 0 if the given index is out of range
- Return values
-
-ERR_PARAM_RANGE If the given device index is out of range ERR_NOERR indicates success
| long LCAIO_LookupInChanByName | ( | const char * | pChannelName, |
| dev_hdl * | pInChanHdl | ||
| ) |
Lookup for an analog input channel by its name.
- Parameters
-
[in] pChannelName The name to assign with this channel [out] pInChanHdl Handle to input channel handle if the channel was sucessfully opened
- Return values
-
-ERR_NODEV No device with the given name found ERR_NOERR indicates success
- Examples:
- capi_dynamic_controller_test.cpp.
| long LCAIO_LookupOutChanByName | ( | const char * | pChannelName, |
| dev_hdl * | pOutChanHdl | ||
| ) |
Lookup for an analog output channel by its name.
- Parameters
-
[in] pChannelName The name to assign with this channel [out] pOutChanHdl Handle to output channel handle if the channel was sucessfully opened
- Return values
-
-ERR_NODEV No device with the given name found ERR_NOERR indicates success
- Examples:
- capi_dynamic_controller_test.cpp.