fwMCS  8.4.0
fwMCS.ctl File Reference

Functions

 fwMCS_subscribeExperiment (string experim, dyn_string &exceptionInfo)
 
 fwMCS_unsubscribeExperiment (string experim)
 
 _fwCreateDPT (string dptName, dyn_string fieldNames, dyn_int fieldTypes, string type, dyn_string &exceptionMessage)
 
bool _DPTExists (string pattern)
 
 _setModelData (string newDp, dyn_string dS1, string current)
 
 _configureAdditionalDpe (string curDpe, string ramDpe, string magnetSel, string experiment)
 
 _getValuesDeviceUnit (string DPT, string current, string ramping, dyn_dyn_string &names, dyn_string &exceptionMessage)
 
 _createDeviceUnit (string fwMagnetDP, dyn_dyn_string values)
 
 _getDptFieldData (string DPT, dyn_string &dfn)
 
bool _isSameStructure (dyn_string ds1, dyn_string ds2)
 
 _getDataType (int typeIn, string &typeOut)
 

Detailed Description

This library contains functions and constants needed by the fwMCS -

  • the Magnet
Creation Date
14/06/2006
Modification History
None
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Author
Laura Fernández Nocelo (IT-CO)

Function Documentation

fwMCS_subscribeExperiment ( string  experim,
dyn_string &  exceptionInfo 
)
Function used for subscribing all the publications for an experiment
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Reviewed:
2018-08-16 API
Parameters
experimname of the experiment
exceptionInfooutput, information about errors
fwMCS_unsubscribeExperiment ( string  experim)
Function used for unsubscribing all the publications for an experiment
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Reviewed:
2018-08-16 API
Parameters
experimname of the experiment
_fwCreateDPT ( string  dptName,
dyn_string  fieldNames,
dyn_int  fieldTypes,
string  type,
dyn_string &  exceptionMessage 
)

Function used for creating or changing a DPT for the DIP subscription

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
dptNameinput, the name the DPT to create
fieldNamesinput, field names of the DPT
fieldTypesinput, field types of the DPT
typeinput, specify if the DPT has to be created on changed
exceptionMessageoutput, information about errors
bool _DPTExists ( string  pattern)

Function checks if the given dpt exist

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
patterninput, the pattern the DPT to check
_setModelData ( string  newDp,
dyn_string  dS1,
string  current 
)

Function used for setting the model data

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
newDpinput, the name the DPT for the model
dS1input, field names of publication
currentinput, name of the current value
_configureAdditionalDpe ( string  curDpe,
string  ramDpe,
string  magnetSel,
string  experiment 
)

Function used for configuing additional dpe's used in the DU Type

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
curDpeinput, the name of the current value in the publication
ramDpeinput, the name of the ramping value in the publication
magnetSelinput, the name of the selected magnet which is published
experimentinput, the name of the selected experiment
_getValuesDeviceUnit ( string  DPT,
string  current,
string  ramping,
dyn_dyn_string &  names,
dyn_string &  exceptionMessage 
)

For a given DTP the function returns the structure with the current and ramping value and their types.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
DPTinput, the name of the DPT
currentinput, the name of the current value in the publication
rampinginput, the name of the ramping value in the publication
namesoutput, structure with the current and ramping value and their types
exceptionMessageoutput, information about errors
_createDeviceUnit ( string  fwMagnetDP,
dyn_dyn_string  values 
)

Function for creating a DU Type for the magnets of an experiment.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
fwMagnetDPinput, the name of the DPT for the magnets of an experiment
valuesinput, structure with the current and ramping value and their types
_getDptFieldData ( string  DPT,
dyn_string &  dfn 
)

For a given DTP the function gets the structure with the names of its dpes.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
DPTinput, the name of the DPT
dfnoutput, structure with the names of the dpes for the DPT
bool _isSameStructure ( dyn_string  ds1,
dyn_string  ds2 
)

Checks if two structures have the same content.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
ds1input, structure number 1
ds2input, structure number 2
_getDataType ( int  typeIn,
string &  typeOut 
)

Returns the type in a string.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters
typeIninput, type in a int
typeOutoutput, type in a string