fwConfigurationDB  8.4.2
Recipe Functions

Functions

void fwConfigurationDB_GetRecipeFromSystem (dyn_dyn_mixed &recipeObject, dyn_string deviceList, string hierarchyType, dyn_string &exceptionInfo, dyn_string deviceSystems="")
 
void fwConfigurationDB_ApplyRecipe (dyn_dyn_mixed recipeObject, string hierarchyType, dyn_string &exceptionInfo, bool allowApplyRemote=FALSE)
 
string fwConfigurationDB_createRecipeCache (string recipeName, dyn_string &exceptionInfo, string recipeComment="", string hierarchyType="")
 
void fwConfigurationDB_storeRecipeInCache (dyn_dyn_mixed recipeObject, string cacheName, string hierarchyType, dyn_string &exceptionInfo)
 
void fwConfigurationDB_getRecipeFromCache (string cacheName, dyn_string deviceList, string hierarchyType, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string systemName="")
 
void fwConfigurationDB_storeDiffRecipeInDB (dyn_dyn_mixed recipeObject, string hierarchyType, string versionDescription, dyn_string &exceptionInfo, string tag, string systemName="", bool autoSaveDevices=FALSE)
 
void fwConfigurationDB_storeRecipeInDB (dyn_dyn_mixed recipeObject, string hierarchyType, string versionDescription, dyn_string &exceptionInfo, string tag)
 
void fwConfigurationDB_getRecipeFromDB (string topDevice, dyn_string deviceList, string hierarchyType, string tag, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string systemName="", time validAt=0)
 
void fwConfigurationDB_makeRecipe (dyn_string deviceElements, dyn_mixed settings, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, bool checkExists=TRUE)
 

Public Functions for Recipe Handling

Naming conventions:

  • operations:
    • load/save From/To Cache/DB
    • extract/apply
    • get Recipes In DB/Cache
    • get/set Description In Cache/DB
  • parameters:
    • recipeObject , recipeObject1, recipeObject2, diffRecipeObject, templateRecipeObject deviceName, deviceList, hierarchyType, recipeName, recipeList

Note that the functions used in version 3.0.X will still be supported in 3.1.X, yet their use is deprecated.

void fwConfigurationDB_loadRecipeFromCache (string recipeName, dyn_string deviceList, string hierarchyType, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string systemName="")
 
void fwConfigurationDB_loadRecipeFromDB (string recipeName, dyn_string deviceList, string hierarchyType, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string systemName="", string topDevice="", time validAt=0)
 
void fwConfigurationDB_saveRecipeToDB (dyn_dyn_mixed recipeObject, string hierarchyType, string recipeName, dyn_string &exceptionInfo, string versionDescription="", bool autoSaveDevices=FALSE)
 
void fwConfigurationDB_saveRecipeToCache (dyn_dyn_mixed recipeObject, string hierarchyType, string recipeName, dyn_string &exceptionInfo)
 
void fwConfigurationDB_saveDiffRecipeToDB (dyn_dyn_mixed recipeObject, string hierarchyType, string recipeName, dyn_string &exceptionInfo, string versionDescription="", bool autoSaveDevices=FALSE)
 
synchronized void fwConfigurationDB_extractRecipe (dyn_string deviceList, string hierarchyType, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string recipeType="", dyn_string deviceSystems="", string recipeTypeSystem="")
 
void fwConfigurationDB_applyRecipe (dyn_dyn_mixed recipeObject, string hierarchyType, dyn_string &exceptionInfo, bool allowApplyRemote=FALSE)
 
void fwConfigurationDB_getRecipeDescriptionInCache (string recipeName, string &recipeDescription, dyn_string &exceptionInfo)
 
void fwConfigurationDB_getRecipeDescriptionInDB (string recipeName, string &recipeDescription, dyn_string &exceptionInfo)
 
void fwConfigurationDB_setRecipeDescriptionInCache (string recipeName, string recipeDescription, dyn_string &exceptionInfo)
 
void fwConfigurationDB_setRecipeDescriptionInDB (string recipeName, string recipeDescription, dyn_string &exceptionInfo)
 
void fwConfigurationDB_setRecipeTypeInfoInDB (string recipeName, string recipeTypeName, dyn_string &exceptionInfo)
 
void fwConfigurationDB_getRecipesInDB (dyn_string &recipeList, dyn_string &exceptionInfo, string deviceName="")
 
void fwConfigurationDB_getRecipesInCache (dyn_string &recipeList, dyn_string &exceptionInfo, string deviceName="", string systemName="")
 
bool fwConfigurationDB_editRecipe (dyn_dyn_mixed &recipeObject, bool readOnly=FALSE, string description="")
 
void fwConfigurationDB_makeRecipeFromTemplate (dyn_string deviceNames, string hierarchyType, dyn_dyn_mixed templRecipeObject, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo)
 
void fwConfigurationDB_setRecipeType (string recipeType, dyn_string &exceptionInfo, string systemName="")
 
void fwConfigurationDB_combineRecipes (dyn_dyn_mixed &dstRecipeObject, dyn_dyn_mixed srcRecipeObject1, dyn_dyn_mixed srcRecipeObject2, dyn_string &exceptionInfo, string mergeMode="")
 
void fwConfigurationDB_getRecipeMetaInfoInCache (string recipeName, dyn_string &exceptionInfo, string &hierarchyType, string &recipeComment, string &recipeType)
 
void fwConfigurationDB_getRecipeMetaInfoInDB (string recipeName, dyn_string &exceptionInfo, string &hierarchyType, string &recipeComment, string &recipeType)
 
int fwConfigurationDB_findRecipesInCache (dyn_string &recipeNames, dyn_string &exceptionInfo, string recipeName="*", string hierarchyType="*", string recipeComment="*", string recipeType="*", string deviceName="*", string recipeClass="*")
 
int fwConfigurationDB_findRecipesInDB (dyn_string &recipeNames, dyn_string &exceptionInfo, string recipeName="*", string hierarchyType="", string recipeComment="*", string recipeType="*", string deviceName="*")
 

Detailed Description

Function Documentation

void fwConfigurationDB_loadRecipeFromCache ( string  recipeName,
dyn_string  deviceList,
string  hierarchyType,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  systemName = "" 
)

Loads a recipe from cache to recipe object

Parameters
recipeNamethe name of the recipe cache; could be prefixed with system name and a colon to get recipe from a remote dist system (eg. "dist_2:MYRECIPE"); (see also comments below)
deviceListlist of the devices for which recipe is loaded; specifying empty list means: load the recipe data for all devices it includes
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObjectthe recipe data will be stored in this variable
exceptionInfostandard exception handling routine
systemName(compatibility, optional) comma-separated list of system names on which logical device names should be looked up; empty string (default) means that lookup is done on local system only
Note
In the following cases, logical devices from remote systems will be resolved correctly
  • if fwConfigurationDB_allowResolveRemote is set to TRUE, then all connected dist systems will be searched to resolve devices
  • if systemName parameter is not empty, then it is treated as a comma-separated list of systems to be searched for devices
  • if a recipe is loaded from a remote system (ie. recipeName parameter is prefixed with system name, then devices will be lookes up in this system.
See Also
fwConfigurationDB_getRecipeFromCache
void fwConfigurationDB_loadRecipeFromDB ( string  recipeName,
dyn_string  deviceList,
string  hierarchyType,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  systemName = "",
string  topDevice = "",
time  validAt = 0 
)

Loads a recipe from database to recipe object

Parameters
recipeNamethe name of the recipe
deviceListlist of the devices for which recipe is loaded; specifying empty list means: load the recipe data for all devices it includes
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObjectthe recipe data will be stored in this variable
exceptionInfostandard exception handling routine
systemName(compatibility, optional) comma-separated list of system names on which logical device names should be looked up; empty string (default) means that lookup is done on local system only
topDevice(optional) the name of the top device in the hierarchy, from which the devices should be searched for. Allows to load the recipe for a sub-tree of devices that start at topDevice; it may also speed-up the search in the device tree.
By default, empty string is used which means: start the search from the top of the hierachy (i.e. search through the complete list of devices).
validAt(optional) allows to query the history of recipes; 0 (default) means: extract the recipe as it is configured now, other date means: extract the recipe as it looked at that date.
See Also
fwConfigurationDB_getRecipeFromDB
void fwConfigurationDB_saveRecipeToDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  recipeName,
dyn_string &  exceptionInfo,
string  versionDescription = "",
bool  autoSaveDevices = FALSE 
)

Saves a recipe contained in recipeObject to the database

If a recipe with specified name already exists, a new version for the recipe is stored - the old settings for the device elements include in the new recipe object are not lost - the history is kept. Otherwise, a new recipe is created in the database.

Parameters
recipeObjectthe recipe data that is to be stored
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeNamethe name for the recipe
exceptionInfostandard exception handling routine
versionDescription(optional) description for the new version of recipe data. Note that this is not a recipe comment - it should be rather considered as the documentation of the reason for which the recipe is changed (e.g. like adding a comment when committing changes in CVS).
autoSaveDevicesif true, the minimal configuration for devices will be stored
See Also
fwConfigurationDB_storeRecipeInDB
void fwConfigurationDB_saveRecipeToCache ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  recipeName,
dyn_string &  exceptionInfo 
)

Saves a recipe contained in recipeObject to the cache

If a recipe cache with specified name already exists, it is overwritten by the new recipe. Otherwise a new recipe cache is created.

Parameters
recipeObjectthe recipe data that is to be stored in the cache
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeNamethe name for the recipe cache
exceptionInfostandard exception handling routine
See Also
fwConfigurationDB_storeRecipeInCache
void fwConfigurationDB_saveDiffRecipeToDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  recipeName,
dyn_string &  exceptionInfo,
string  versionDescription = "",
bool  autoSaveDevices = FALSE 
)

Saves a differential recipe to the database

The function compares the data stored in the recipeObject with the data saved in the recipe specified by in the database, then stores the changes (differences) to this recipe in the database.

Parameters
recipeObjectthe recipe data that is to be stored in the cache
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeNamethe name of the recipe
exceptionInfostandard exception handling routine
versionDescription(optional) description for the new version of recipe data. Note that this is not a recipe comment - it should be rather considered as the documentation of the reason for which the recipe is changed (e.g. like adding a comment when committing changes in CVS).
See Also
fwConfigurationDB_storeDiffRecipeInDB
synchronized void fwConfigurationDB_extractRecipe ( dyn_string  deviceList,
string  hierarchyType,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  recipeType = "",
dyn_string  deviceSystems = "",
string  recipeTypeSystem = "" 
)

Creates a recipe containing current settings of the system

For a list of devices specified in deviceList, the current values and alarm settings are extracted from the system (according to selected recipe type), and placed in the recipeObject.

Parameters
deviceListthe list of devices to be included in the recipe
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObjectthe recipe data will be stored in this variable
exceptionInfostandard exception handling routine
recipeType(optional) the recipe type to be used. By default (empty string), the currently selected recipe type will be used. Otherwise, the specified recipe type will be used for this extraction, and then the one used previously will be restored
deviceSystems(optional) specifies the systems from which the recipe should be snapshoted; "" can be passed to snapshot only the local system and "*" to snapshot all systems
recipeTypeSystem(optional) specifies the system from which the recipeType should be retrieved
See Also
fwConfigurationDB_GetRecipeFromSystem
void fwConfigurationDB_applyRecipe ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
dyn_string &  exceptionInfo,
bool  allowApplyRemote = FALSE 
)

Applies the recipe to the system

Parameters
recipeObjectthe data containing the recipe to be applied
hierarchyTypethe type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
exceptionInfostandard exception handling routine
allowApplyRemoteif set to TRUE, then it is possible to apply a recipe that contains setting for devices in other systems
See Also
fwConfigurationDB_ApplyRecipe
void fwConfigurationDB_getRecipeDescriptionInCache ( string  recipeName,
string &  recipeDescription,
dyn_string &  exceptionInfo 
)

Gets the description of the recipe cache

Parameters
recipeNamespecifies the name of the recipe (cache)
recipeDescriptionon return will contain the description of the recipe
exceptionInfostandard exception handling routine
void fwConfigurationDB_getRecipeDescriptionInDB ( string  recipeName,
string &  recipeDescription,
dyn_string &  exceptionInfo 
)

Gets the description of the recipe stored in database

Parameters
recipeNamespecifies the name of the recipe
recipeDescriptionon return will contain the description of the recipe
exceptionInfostandard exception handling routine
void fwConfigurationDB_setRecipeDescriptionInCache ( string  recipeName,
string  recipeDescription,
dyn_string &  exceptionInfo 
)

Sets the description of the recipe cache

Parameters
recipeNamespecifies the name of the recipe (cache)
recipeDescriptionshould contain the new description for the recipe
exceptionInfostandard exception handling routine
void fwConfigurationDB_setRecipeDescriptionInDB ( string  recipeName,
string  recipeDescription,
dyn_string &  exceptionInfo 
)

Sets the description of the recipe in database

Parameters
recipeNamespecifies the name of the recipe (cache)
recipeDescriptionshould contain the new description for the recipe
exceptionInfostandard exception handling routine
void fwConfigurationDB_setRecipeTypeInfoInDB ( string  recipeName,
string  recipeTypeName,
dyn_string &  exceptionInfo 
)

Sets the recipeType info for the recipe in database

Parameters
recipeNamespecifies the name of the recipe (cache)
recipeTypeNameshould contain the new recipeType for the recipe
exceptionInfostandard exception handling routine
void fwConfigurationDB_getRecipesInDB ( dyn_string &  recipeList,
dyn_string &  exceptionInfo,
string  deviceName = "" 
)

Gets the list of recipes available in database

Parameters
recipeListon return will contain the list of recipe names (cache names)
exceptionInfostandard exception handling routine
deviceName(optional) the device for which the recipes are being looked-up; specifying empty string (default) returns all available recipes
See Also
fwConfigurationDB_findRecipesInDB
void fwConfigurationDB_getRecipesInCache ( dyn_string &  recipeList,
dyn_string &  exceptionInfo,
string  deviceName = "",
string  systemName = "" 
)

Gets the list of recipes available in cache on local or remote system

Parameters
recipeListon return will contain the list of recipe names
exceptionInfostandard exception handling routine
deviceName(optional) the device for which the recipes are being looked-up; specifying empty string (default) returns all available recipes in the system.
systemNameallows to get the list of recipe caches on a remote system. passing the "*" value will look up in all dist systems
See Also
fwConfigurationDB_findRecipesInCache
bool fwConfigurationDB_editRecipe ( dyn_dyn_mixed &  recipeObject,
bool  readOnly = FALSE,
string  description = "" 
)

Opens recipe editor panel.

May only be used from UI manager.

Returns
TRUE if the recipe was changed (i.e. OK was clicked)
void fwConfigurationDB_makeRecipeFromTemplate ( dyn_string  deviceNames,
string  hierarchyType,
dyn_dyn_mixed  templRecipeObject,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo 
)

Make a recipe out of a recipe template and a list of devices (items)

Parameters
deviceNameslist of target device (item) names; the must exist in the current system.
hierarchyType(dummy)
templRecipeObjecta recipeObject that contains the recipe template.
recipeObjecton return the recipe made of template will be appended to this object
exceptionInfostandard exception handling variable
Reviewed:
2018-06-22 API
void fwConfigurationDB_setRecipeType ( string  recipeType,
dyn_string &  exceptionInfo,
string  systemName = "" 
)

sets the recipe type to be used

Parameters
recipeTypespecifies the name of the recipe type
exceptionInfostandard exception handling variable
systemNameallows to use recipe type on remote systems
Exceptions
exceptionInfo[3]may return the following error codes:

If any of the error exceptions was signaled, the current recipe type is reset to an empty recipe.

See Also
Recipes section of Quick Start
void fwConfigurationDB_combineRecipes ( dyn_dyn_mixed &  dstRecipeObject,
dyn_dyn_mixed  srcRecipeObject1,
dyn_dyn_mixed  srcRecipeObject2,
dyn_string &  exceptionInfo,
string  mergeMode = "" 
)

combines two recipe objects This function combines two recipe object into third object. For the entries that exist in both source recipes, the one in the second recipe have precedence, and will be used.

The meta-information is treated in the following way: if there is no meta information yet in the first recipe, the meta information from srcRecipeObject2 is taken; otherwise, if there is already a meta-information in the srcRecipeObject1, it is discarded except the recipe type name - this one will be set in the dstRecipeObject if it is set in both srcRecipeObjects to equal values.

Parameters
dstRecipeObjecton return will contain the combined recipe
srcRecipeObject1first recipe to combine
srcRecipeObject2second recipe to combine
exceptionInfostandard exception handling variable
mergeMode(optional, default="") determines the mode in which the merge is performed;
  • "DEVICE" - for device that is in both recipeObjects, all the elements from recipeObject2 are taken, and nothing from recipeObject1
  • "ELEMENT" - for device that is in both recipeObjects, all the elements from both recipeObject are used, and when the elements are in both then the settiings from recipeObject2 are taken -"" - take the global setting from fwConfigurationDB_defaultRecipeMergeMode
See Also
Recipes section of Quick Start
void fwConfigurationDB_GetRecipeFromSystem ( dyn_dyn_mixed &  recipeObject,
dyn_string  deviceList,
string  hierarchyType,
dyn_string &  exceptionInfo,
dyn_string  deviceSystems = "" 
)

Reads properties of device(s) from PVSS and stores in recipeObject

This function reads the data from specified data points (devices), according to current recipeType, then appends it to the data already stored in the recipeObject.

Parameters
recipeObjectthe structure containing recipe data. The new settings will be appended to it. See also recipeObject data structure description.
deviceListlist of device names (from whatever hierarchy)
hierarchyTypehierarchy type - not used anymore!
exceptionInfostandard exception handling variable
deviceSystemscomma-separated list of system names at which logical devices will be looked up
See Also
Recipes section of Quick Start
Deprecated:
Please use fwConfigurationDB_extractRecipe instead
void fwConfigurationDB_ApplyRecipe ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
dyn_string &  exceptionInfo,
bool  allowApplyRemote = FALSE 
)

Applies a recipe stored in recipeObject to the system

Parameters
recipeObjectthe structure containing recipe data. See also recipeObject data structure description.
hierarchyTypehierarchy type (fwDevice_HARDWARE, fwDevice_LOGICAL, etc)
exceptionInfostandard exception handling variable
allowApplyRemote(optional, default=FALSE) allows to perform dpSet's to remote locations; by default this is disabled (i.e. only local operations allowed) for security
See Also
Recipes section of Quick Start
Deprecated:
use fwConfigurationDB_applyRecipe instead
string fwConfigurationDB_createRecipeCache ( string  recipeName,
dyn_string &  exceptionInfo,
string  recipeComment = "",
string  hierarchyType = "" 
)

Creates an empty recipe cache

Parameters
recipeNamethe name of the recipe cache
exceptionInfostandard exception handling variable
recipeComment(optional) comment for recipe type
hierarchyType(optional) hierarchy type, dummy now!
See Also
Recipes section of Quick Start
void fwConfigurationDB_storeRecipeInCache ( dyn_dyn_mixed  recipeObject,
string  cacheName,
string  hierarchyType,
dyn_string &  exceptionInfo 
)

Saves the recipe in a recipe cache

Parameters
recipeObjectshould contain the recipe data; you may store recipe remotely if you prefix the cacheName with system name.
cacheNamethe name of the cache. Note that if the cache does not exits, it will be created.
hierarchyTypehierarchy type, dummy now...
exceptionInfostandard exception handling variable
See Also
Recipes section of Quick Start
Deprecated:
use fwConfigurationDB_saveRecipeToCache instead
void fwConfigurationDB_getRecipeFromCache ( string  cacheName,
dyn_string  deviceList,
string  hierarchyType,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  systemName = "" 
)

Loads a recipe from recipe cache

Parameters
cacheNamethe name of the recipe cache; could be prefixed with system name and colon
deviceListthe list of devices for which the recipe should be loaded. specifying empty list means that all devices in the recipe should be loaded
hierarchyTypehierarchy type, dummy now
recipeObjecton return will contain the recipe data
exceptionInfostandard exception handling variable
systemName(compatibility, optional) comma-separated list of system names on which logical device names should be looked up; empty string (default) means that lookup is done on local system only
See Also
Recipes section of Quick Start
Deprecated:
use fwConfigurationDB_loadRecipeFromCache instead
Note
Please see fwConfigurationDB_loadRecipeFromCache for full description of functionality, in particular for remote recipes.
void fwConfigurationDB_storeDiffRecipeInDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  versionDescription,
dyn_string &  exceptionInfo,
string  tag,
string  systemName = "",
bool  autoSaveDevices = FALSE 
)

Saves the differences in recipe to the database

This function firstly compares the specified recipe with the one already in the database then stores only the differences

Parameters
recipeObjectshould contain the recipe data to be stored
hierarchyTypedummy now
versionDescriptiona text describing this version
exceptionInfostandard exception handling variable
tagrecipe tag (recipe name)
See Also
Apply Recipes section of the Quick Start
Deprecated:
use fwConfigurationDB_saveDiffRecipeToDB instead
void fwConfigurationDB_storeRecipeInDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  versionDescription,
dyn_string &  exceptionInfo,
string  tag 
)

Saves recipe to the database

This function stores a new version of recipe data,

Parameters
recipeObjectshould contain the recipe data to be stored
hierarchyTypethe type of Framework hierarchy: fwDevice_HARDWARE or fwDevice_LOGICAL.
versionDescriptiona text describing this version
exceptionInfostandard exception handling variable
tagrecipe name; if empty name is specified, the function will try to figure out the name from the meta-information stored in the recipeObject
See Also
Apply Recipes section of the Quick Start
Deprecated:
use fwConfigurationDB_saveRecipeToDB instead
void fwConfigurationDB_getRecipeFromDB ( string  topDevice,
dyn_string  deviceList,
string  hierarchyType,
string  tag,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  systemName = "",
time  validAt = 0 
)

Loads a recipe from database

Parameters
topDevicethe top device in the hierarchy - it is a "hint" for the database, telling where to start looking for. An empty string ("") may safely be specified to tell that the devices should be searched for starting from the very top of hierarchy.
deviceListthe list of devices for which the recipe should be loaded. specifying empty list will result in loading the whole recipe data (for all devices)
hierarchyTypehierarchy type, dummy parameter now...
tagthe recipe tag (recipe name)
recipeObjecton return will contain the recipe data
exceptionInfostandard exception handling variable
systemName(compatibility, optional) comma-separated list of system names on which logical device names should be looked up; empty string (default) means that lookup is done on local system only param validAt (optional) allow to retrieve a historical version of recipe, as it looked at the point in time specified in this parameter
See Also
Recipes section of Quick Start
Deprecated:
use fwConfigurationDB_loadRecipeFromDB instead
void fwConfigurationDB_makeRecipe ( dyn_string  deviceElements,
dyn_mixed  settings,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
bool  checkExists = TRUE 
)

Create an ad-hoc recipeObject based on list of device elements and their settings

Parameters
[in]deviceElements,:list of device elements. The devices may come either from the hardware or from logical view. Each device name should be followed by element name. For instance: dist_1:CAEN/crate1/board00/channel000.settings.v0 (for HARDWARE: it is simply the full data point element name), or MyDetector/ECAL/HV/straw0.settings.i0 (for LOGICAL: it is the device's LOGICAL name followed by the element name, and the element name starts with "." character).
[in]settingslist containing settings for corresponding devices in the deviceElements list. If empty list is passed, these will be snapshotted from the current online values for corresponding dpes
[out]recipeObjectwill be filled with the recipe object created from provided input
[out]exceptionInfostandard exception handling object
[in]checkExists(optional), if set to TRUE, the list of device elements will be checked to see if all of the specified device elements exist. Should be set to FALSE if a recipeObject is to be created with settings for devices that do not exist yet. Note that without checkExists=TRUE, the recipeObject will have limited usability, namely it cannot be stored to cache or applied to system! In this mode we query aliases from all systems though.
void fwConfigurationDB_getRecipeMetaInfoInCache ( string  recipeName,
dyn_string &  exceptionInfo,
string &  hierarchyType,
string &  recipeComment,
string &  recipeType 
)

Returns meta-information describing a recipe in cache

void fwConfigurationDB_getRecipeMetaInfoInDB ( string  recipeName,
dyn_string &  exceptionInfo,
string &  hierarchyType,
string &  recipeComment,
string &  recipeType 
)

Returns meta-information describing a recipe in database

int fwConfigurationDB_findRecipesInCache ( dyn_string &  recipeNames,
dyn_string &  exceptionInfo,
string  recipeName = "*",
string  hierarchyType = "*",
string  recipeComment = "*",
string  recipeType = "*",
string  deviceName = "*",
string  recipeClass = "*" 
)
returns the list of recipes in cache matching specified criteria
Returns
the number of matching recipes found
int fwConfigurationDB_findRecipesInDB ( dyn_string &  recipeNames,
dyn_string &  exceptionInfo,
string  recipeName = "*",
string  hierarchyType = "",
string  recipeComment = "*",
string  recipeType = "*",
string  deviceName = "*" 
)
returns the list of recipes in the database matching specified criteria
Returns
the number of matching recipes found, or -1 in case of error