fwConfigs
 All Files Functions Variables Groups Pages
fwPeriphAddressCMW.ctl File Reference

Functions

 _fwPeriphAddressCMW_set (string dpe, dyn_anytype addressConfig, dyn_string &exceptionInfo)
 
 _fwPeriphAddressCMW_get (string dpe, dyn_anytype &addressConfig, bool &isActive, dyn_string &exceptionInfo)
 
 _fwPeriphAddressCMW_delete (string dpe, dyn_string &exceptionInfo)
 
 _fwPeriphAddressCMW_initPanel (string dpe, dyn_string &exceptionInfo)
 
 fwPeriphAddressCMW_check (dyn_string dsParameters, dyn_string &exceptionInfo)
 
 fwPeriphAddressCMW_getTransformation (int cmw_direction, int iCmw_trans, string dpe)
 
 fwPeriphAddressCMW_setTransformation (int &cmw_direction, int &cmw_mode, int &cmw_trans, bool &cmw_lowlevel, string dpe)
 
 _fwPeriphAddressCMW_setTransformation (bool bMonitorOn, int &cmw_direction, int &cmw_mode, int &cmw_trans, bool &cmw_lowlevel, string dpe)
 

Variables

const string fwPeriphAddress_TYPE_CMW = "CMW"
 
const int CMW_DEFAULT_DRIVER_NUMBER = 2
 
const string CMW_DEFAULT_REFERENCE = "reference$property$tag"
 
const bool CMW_DEFAULT_ACTIVE = TRUE
 
const int CMW_DEFAULT_SUBINDEX = 0
 
const bool CMW_DEFAULT_LOWLEVEL = FALSE
 
const int CMW_DEFAULT_DIRECTION = 0
 
const int CMW_DEFAULT_MODE = 0
 
const int CMW_NO_MONITORON = 1000
 
const int CMW_TRANS_OFFSET = 1000
 
const unsigned fwPeriphAddress_CMW_LOWLEVEL = 11
 
const unsigned fwPeriphAddress_CMW_SUBINDEX = 12
 
const unsigned fwPeriphAddress_CMW_START = 13
 
const unsigned fwPeriphAddress_CMW_INTERVAL = 14
 
const unsigned fwPeriphAddress_CMW_POLL_GROUP = 15
 
const unsigned fwPeriphAddress_CMW_MODE = 16
 

Detailed Description

This library contains function associated with CMW addressing. Functions are provided to set, get and delete the addressing for a dpe

Creation Date
25/04/2005
Modification History

08/01/2014: Marco Boccioli

  • FWCORE-3149 fwConfig get periph address CMW: error when the address is configured with spontaneous input

28/05/2008: Herve

  • new function: _fwPeriphAddressCMW_setTransformation identical to fwPeriphAddressCMW_setTransformation without reference to a graphical element.
  • fwPeriphAddressCMW_setTransformation call _fwPeriphAddressCMW_setTransformation
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Celine VUILLERMOZ (AB-CO)

Function Documentation

_fwPeriphAddressCMW_delete ( string  dpe,
dyn_string &  exceptionInfo 
)

Delete the CMW addressing Note: This function should not be called directly. Call the fwPeriphAddress_delete instead.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, data point element to configure
exceptionInfooutput, details of any exceptions are returned here
_fwPeriphAddressCMW_get ( string  dpe,
dyn_anytype &  addressConfig,
bool &  isActive,
dyn_string &  exceptionInfo 
)

Get the CMW addressing Note: This function should not be called directly. Call the fwPeriphAddress_get instead.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, data point element to read
addressConfigoutput, object containing address configuration details
isActiveoutput, TRUE is addressing is active, else FALSE
exceptionInfooutput, details of any exceptions are returned here
_fwPeriphAddressCMW_initPanel ( string  dpe,
dyn_string &  exceptionInfo 
)

Initialise the graphics of the address panel symbol. Note: This function should only be called from fwPeriphAddres.pnl.

Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters
dpeinput, data point element to configure
exceptionInfooutput, details of any exceptions are returned here

References fwPeriphAddress_get(), and fwPeriphAddressCMW_getTransformation().

+ Here is the call graph for this function:

_fwPeriphAddressCMW_set ( string  dpe,
dyn_anytype  addressConfig,
dyn_string &  exceptionInfo 
)

Set the CMW addressing Note: This function should not be called directly. Call the fwPeriphAddress_set instead.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dpeinput, data point element to configure
addressConfiginput, object containing address configuration details
exceptionInfooutput, details of any exceptions are returned here

References FW_PARAMETER_FIELD_DRIVER, and fwPeriphAddressCMW_check().

+ Here is the call graph for this function:

_fwPeriphAddressCMW_setTransformation ( bool  bMonitorOn,
int &  cmw_direction,
int &  cmw_mode,
int &  cmw_trans,
bool &  cmw_lowlevel,
string  dpe 
)

Set the transformation of CMW address

Constraints
None
Usage
Internal function
PVSS managers
VISION, CTRL
Parameters
bMonitorOninput, true=monitorOn/false=no monitorOn
cmw_directionoutput, direction of the driver
cmw_modeoutput, Receive mode
cmw_transoutput, driver type tranformation
cmw_lowleveloutput, is the low level comparison set ?
dpeinput, data point element to configure

Referenced by fwPeriphAddressCMW_setTransformation().

fwPeriphAddressCMW_check ( dyn_string  dsParameters,
dyn_string &  exceptionInfo 
)

Check if data is Ok to set a CMW address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
dsParametersparameters used to set the _address config (see constants definition)
exceptionInfofor any error. If a parameter is incorrect, exceptionInfo is not empty !

References FW_PARAMETER_FIELD_ACTIVE, FW_PARAMETER_FIELD_ADDRESS, FW_PARAMETER_FIELD_COMMUNICATION, FW_PARAMETER_FIELD_DATATYPE, FW_PARAMETER_FIELD_DRIVER, FW_PARAMETER_FIELD_INTERVAL, FW_PARAMETER_FIELD_LOWLEVEL, FW_PARAMETER_FIELD_MODE, FW_PARAMETER_FIELD_NUMBER, FW_PARAMETER_FIELD_START, and FW_PARAMETER_FIELD_SUBINDEX.

Referenced by _fwPeriphAddressCMW_set().

fwPeriphAddressCMW_getTransformation ( int  cmw_direction,
int  iCmw_trans,
string  dpe 
)

Calculate the transformation of CMW address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
cmw_directioninput, value used to know the direction of the driver
iCmw_transinput, driver type tranformation
dpeinput, data point element to configure

Referenced by _fwPeriphAddressCMW_initPanel().

fwPeriphAddressCMW_setTransformation ( int &  cmw_direction,
int &  cmw_mode,
int &  cmw_trans,
bool &  cmw_lowlevel,
string  dpe 
)

Set the transformation of CMW address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
cmw_directionoutput, direction of the driver
cmw_modeoutput, Receive mode
cmw_transoutput, driver type tranformation
cmw_lowleveloutput, is the low level comparison set ?
dpeinput, data point element to configure

References _fwPeriphAddressCMW_setTransformation().

+ Here is the call graph for this function: