Recipe Functions


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="")
void fwConfigurationDB_extractRecipe (dyn_string deviceList, string hierarchyType, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, string recipeType="")
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 system="")
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="*")
int fwConfigurationDB_findRecipesInDB (dyn_string &recipeNames, dyn_string &exceptionInfo, string recipeName="*", string hierarchyType="", string recipeComment="*", string recipeType="*", string deviceName="*")

Functions

void fwConfigurationDB_GetRecipesInDB (string hierarchyType, dyn_string &recipeTags, dyn_string &exceptionInfo)
void fwConfigurationDB_GetDBRecipesForNode (string nodeName, dyn_string &recipeNames, dyn_string &exceptionInfo)
void fwConfigurationDB_GetRecipeCaches (string hierarchyType, dyn_string &recipeCacheNames, dyn_string &recipeCacheDPs, dyn_string &exceptionInfo, string system="")
void fwConfigurationDB_GetCacheRecipesForNode (string nodeName, dyn_string &recipeNames, dyn_string &exceptionInfo, string system="")
void fwConfigurationDB_GetRecipeFromSystem (dyn_dyn_mixed &recipeObject, dyn_string deviceList, string hierarchyType, dyn_string &exceptionInfo)
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 system="")
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 system="", time validAt=0)
void fwConfigurationDB_makeRecipe (dyn_string deviceElements, dyn_mixed settings, dyn_dyn_mixed &recipeObject, dyn_string &exceptionInfo, bool checkExists=TRUE)

Function Documentation

void fwConfigurationDB_GetRecipesInDB ( string  hierarchyType,
dyn_string &  recipeTags,
dyn_string &  exceptionInfo 
)

Gets the list of recipes available in database

Parameters:
hierarchyType dummy parameter now
recipeTags the recipe names will be returned in this variable
exceptionInfo standard exception handling variable
Deprecated:
use fwConfigurationDB_getRecipesInDB or fwConfigurationDB_findRecipesInDB
See also:
Apply Recipes section of the Quick Start

void fwConfigurationDB_GetDBRecipesForNode ( string  nodeName,
dyn_string &  recipeNames,
dyn_string &  exceptionInfo 
)

Gets the list of recipes in database, for specified node

Parameters:
nodeName the name of the node (or device, or datapoint) for which recipes are queried
recipeNames the recipe names will be returned in this variable
exceptionInfo standard exception handling variable
See also:
Apply Recipes section of the Quick Start
Deprecated:
use fwConfigurationDB_getRecipesInDB or fwConfigurationDB_findRecipesInDB

void fwConfigurationDB_GetRecipeCaches ( string  hierarchyType,
dyn_string &  recipeCacheNames,
dyn_string &  recipeCacheDPs,
dyn_string &  exceptionInfo,
string  system = "" 
)

Gets the list of recipes available in recipe caches

Parameters:
hierarchyType the type of Framework hierarchy, dummy now
recipeCacheNames the recipe names will be returned in this variable
recipeCacheDPs the list of datapoints corresponding to the recipe names will be stored in returned in this variable
exceptionInfo standard exception handling variable
system allows to look for recipe caches on remote systems
See also:
Apply Recipes section of the Quick Start
Deprecated:
use fwConfigurationDB_getRecipesInCache instead

void fwConfigurationDB_GetCacheRecipesForNode ( string  nodeName,
dyn_string &  recipeNames,
dyn_string &  exceptionInfo,
string  system = "" 
)

Gets the list of cached recipes for specified node

Parameters:
nodeName the name of the node (or device, or datapoint) for which recipes are queried
recipeNames the recipe names will be returned in this variable
exceptionInfo standard exception handling variable
system allows to look for recipe caches on remote systems
See also:
Apply Recipes section of the Quick Start
Deprecated:
use fwConfigurationDB_getRecipesInCache instead

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:
recipeName the name of the recipe
deviceList list of the devices for which recipe is loaded; specifying empty list means: load the recipe data for all devices it includes
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObject the recipe data will be stored in this variable
exceptionInfo standard exception handling routine
systemName (optional) the name of the system; default value; empty string ("") means local system (default)
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:
recipeName the name of the recipe
deviceList list of the devices for which recipe is loaded; specifying empty list means: load the recipe data for all devices it includes
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObject the recipe data will be stored in this variable
exceptionInfo standard exception handling routine
systemName (optional) dummy
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:
recipeObject the recipe data that is to be stored
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeName the name for the recipe
exceptionInfo standard exception handling routine
versionDescription (optional) description for the new version of recipe data.
autoSaveDevices (optional, default FALSE), if set to TRUE, the function will verify that the devices in the recipeObject were already stored in the DB, and, if needed, will store the mimal information for the missing ones using the fwConfigurationDB_saveDevicesToDBMinimal function. For another example of handling non-stored devices, see the documentation of fwConfigurationDB_saveDevicesToDBMinimal. 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_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:
recipeObject the recipe data that is to be stored in the cache
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeName the name for the recipe cache
exceptionInfo standard exception handling routine
See also:
fwConfigurationDB_storeRecipeInCache

void fwConfigurationDB_saveDiffRecipeToDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  recipeName,
dyn_string &  exceptionInfo,
string  versionDescription = "" 
)

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:
recipeObject the recipe data that is to be stored in the cache
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeName the name of the recipe
exceptionInfo standard 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

void fwConfigurationDB_extractRecipe ( dyn_string  deviceList,
string  hierarchyType,
dyn_dyn_mixed &  recipeObject,
dyn_string &  exceptionInfo,
string  recipeType = "" 
)

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:
deviceList the list of devices to be included in the recipe
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
recipeObject the recipe data will be stored in this variable
exceptionInfo standard 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 set as default using fwConfigurationDB_setRecipeType.
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:
recipeObject the data containing the recipe to be applied
hierarchyType the type of hierarchy (fwDevice_HARDWARE, fwDevice_LOGICAL)
exceptionInfo standard exception handling routine
allowApplyRemote if 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:
recipeName specifies the name of the recipe (cache)
recipeDescription on return will contain the description of the recipe
exceptionInfo standard exception handling routine

void fwConfigurationDB_getRecipeDescriptionInDB ( string  recipeName,
string &  recipeDescription,
dyn_string &  exceptionInfo 
)

Gets the description of the recipe stored in database

Parameters:
recipeName specifies the name of the recipe
recipeDescription on return will contain the description of the recipe
exceptionInfo standard exception handling routine

void fwConfigurationDB_setRecipeDescriptionInCache ( string  recipeName,
string  recipeDescription,
dyn_string &  exceptionInfo 
)

Sets the description of the recipe cache

Parameters:
recipeName specifies the name of the recipe (cache)
recipeDescription should contain the new description for the recipe
exceptionInfo standard exception handling routine

void fwConfigurationDB_setRecipeDescriptionInDB ( string  recipeName,
string  recipeDescription,
dyn_string &  exceptionInfo 
)

Sets the description of the recipe in database

Parameters:
recipeName specifies the name of the recipe (cache)
recipeDescription should contain the new description for the recipe
exceptionInfo standard exception handling routine

void fwConfigurationDB_setRecipeTypeInfoInDB ( string  recipeName,
string  recipeTypeName,
dyn_string &  exceptionInfo 
)

Sets the recipeType info for the recipe in database

Parameters:
recipeName specifies the name of the recipe (cache)
recipeTypeName should contain the new recipeType for the recipe
exceptionInfo standard exception handling routine

void fwConfigurationDB_getRecipesInDB ( dyn_string &  recipeList,
dyn_string &  exceptionInfo,
string  deviceName = "" 
)

Gets the list of recipes available in database

Parameters:
recipeList on return will contain the list of recipe names (cache names)
exceptionInfo standard 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  system = "" 
)

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

Parameters:
recipeList on return will contain the list of recipe names
exceptionInfo standard 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.
system allows to get the list of recipe caches on a remote system.
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:
deviceNames list of target device (item) names; the must exist in the current system.
hierarchyType the hierarchy to which the items in deviceNames variable belong. Note that the devices in the tempRecipeObject may belong to other hierarchy!
templRecipeObject a recipeObject that contains the recipe template.
recipeObject on return the recipe made of template will be appended to this object
exceptionInfo standard exception handling variable

void fwConfigurationDB_setRecipeType ( string  recipeType,
dyn_string &  exceptionInfo,
string  systemName = "" 
)

sets the recipe type to be used

Parameters:
recipeType specifies the name of the recipe type
exceptionInfo standard exception handling variable
systemName allows 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:
dstRecipeObject on return will contain the combined recipe
srcRecipeObject1 first recipe to combine
srcRecipeObject2 second recipe to combine
exceptionInfo standard exception handling variable
mergeMode (optional, default="") determines the mode in which the merge is performed; "DEVICE" - the mode is per device "ELEMENT" - the mode is per element "" - take the global setting
See also:
Recipes section of Quick Start

void fwConfigurationDB_GetRecipeFromSystem ( dyn_dyn_mixed &  recipeObject,
dyn_string  deviceList,
string  hierarchyType,
dyn_string &  exceptionInfo 
)

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:
recipeObject the structure containing recipe data. The new settings will be appended to it. See also recipeObject data structure description.
deviceList list of device names (from whatever hierarchy)
hierarchyType hierarchy type - not used anymore!
exceptionInfo standard exception handling variable
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:
recipeObject the structure containing recipe data. See also recipeObject data structure description.
hierarchyType hierarchy type (fwDevice_HARDWARE, fwDevice_LOGICAL, etc)
exceptionInfo standard 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:
recipeName the name of the recipe cache
exceptionInfo standard 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:
recipeObject should contain the recipe data; you may store recipe remotely if you prefix the cacheName with system name.
cacheName the name of the cache. Note that if the cache does not exits, it will be created.
hierarchyType hierarchy type, dummy now...
exceptionInfo standard 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:
cacheName the name of the cache
deviceList the list of devices for which the recipe should be loaded. specifying empty list means that all devices in the recipe should be loaded
hierarchyType hierarchy type, dummy now
recipeObject on return will contain the recipe data
exceptionInfo standard exception handling variable
system dummy - deprecated
See also:
Recipes section of Quick Start
Deprecated:
use fwConfigurationDB_loadRecipeFromCache instead

void fwConfigurationDB_storeDiffRecipeInDB ( dyn_dyn_mixed  recipeObject,
string  hierarchyType,
string  versionDescription,
dyn_string &  exceptionInfo,
string  tag,
string  system = "" 
)

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:
recipeObject should contain the recipe data to be stored
hierarchyType dummy now
versionDescription a text describing this version
exceptionInfo standard exception handling variable
tag recipe 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:
recipeObject should contain the recipe data to be stored
hierarchyType the type of Framework hierarchy: fwDevice_HARDWARE or fwDevice_LOGICAL.
versionDescription a text describing this version
exceptionInfo standard exception handling variable
tag recipe 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  system = "",
time  validAt = 0 
)

Loads a recipe from database

Parameters:
topDevice the 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.
deviceList the list of devices for which the recipe should be loaded. specifying empty list will result in loading the whole recipe data (for all devices)
hierarchyType hierarchy type, dummy parameter now...
tag the recipe tag (recipe name)
recipeObject on return will contain the recipe data
exceptionInfo standard exception handling variable
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] list containing settings for corresponding devices in the deviceElements list.
[out] recipeObject will be filled with the recipe object created from provided input
[out] exceptionInfo standard 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!

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 = "*" 
)

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


Generated on Thu May 14 12:06:05 2009 for Configuration Database component by  doxygen 1.4.7