unRecipe 9.1.0
unRcpFunctions_privileges.ctl File Reference

Functions

void unRecipeFunctions_getDeviceDefaultPrivileges (string sDpType, string &sOperatorPrivileges, string &sExpertPrivileges, string &sAdminPrivileges, dyn_string exceptionInfo)
 
void unRecipeFunctions_updateRecipeClassPrivileges (string sDpName)
 
void unRecipeFunctions_updateRecipeInstancePrivileges (string sDpName, string sClassName)
 
void unRecipeFunctions_arrangeRecipeInstancePrivileges (string sDefaultOperatorPrivileges, string sDefaultExpertPrivileges, string sDefaultAdminPrivileges, string &sDeviceOperatorPrivileges, string &sDeviceExpertPrivileges, string &sDeviceAdminPrivileges)
 
void _unRecipeFunctions_addPrivileges (dyn_string dsDefaultPrivileges, dyn_string &dsDevicePrivileges1, dyn_string dsDevicePrivileges2, dyn_string dsDevicePrivileges3)
 
void _unRecipeFunctions_removeObsoletePrivileges (dyn_string &dsDevicePrivileges, dyn_string dsDefaultPrivileges1, dyn_string dsDefaultPrivileges2, dyn_string dsDefaultPrivileges3)
 
void unRecipeFunctions_getRecipeInstancePredefinedPrivileges (string sClassName, string &sRcpInstanceDp, string &sAcDomain, string &sOperatorAction, string &sExpertAction, string &sAdminAction)
 
void unRecipeFunctions_editRecipeClassPrivileges (string sRcpClassDp)
 
void _unRecipeFunctions_getDevicePrivileges (string sDpName, string &sAcDomain, string &sOperatorAction, string &sExpertAction, string &sAdminAction)
 
void _unRecipeFunctions_setDevicePrivileges (string sDpName, string sAcDomain, string sOperatorAction, string sExpertAction, string sAdminAction)
 
void unRecipeFunctions_getDefaultClassPrivileges (string sRoleType, dyn_string &dsPrivileges)
 
void unRecipeFunctions_getDefaultInstancePrivileges (string sRoleType, dyn_string &dsPrivileges)
 

Detailed Description

UNICOS Copyright (C) CERN 2017 All rights reserved

unRcpFunctions_privileges.ctl This file contains functions related to the recipes privileges.

Creation Date
15/03/2017
Modification History
Constraints
None
Usage
Public
PVSS managers
Ui, CTRL
Author
Ivan Prieto Barreiro (BE-ICS)

Function Documentation

◆ unRecipeFunctions_getDeviceDefaultPrivileges()

void unRecipeFunctions_getDeviceDefaultPrivileges ( string  sDpType,
string &  sOperatorPrivileges,
string &  sExpertPrivileges,
string &  sAdminPrivileges,
dyn_string  exceptionInfo 
)

Get the default privileges of a recipe device (recipe class or recipe instance).

Parameters
sDpType- [IN] Datapoint type which default privileges are required.
sOperatorPrivileges- [OUT] Default privileges for the operator.
sExpertPrivileges- [OUT] Default privileges for the expert.
sAdminPrivileges- [OUT] Default privileges for the administrator.
exceptionInfo- [OUT] Standard exception handling variable.

◆ unRecipeFunctions_updateRecipeClassPrivileges()

void unRecipeFunctions_updateRecipeClassPrivileges ( string  sDpName)

Update the recipe class privileges.

Parameters
sDpName- [IN] Recipe class DP name.

◆ unRecipeFunctions_updateRecipeInstancePrivileges()

void unRecipeFunctions_updateRecipeInstancePrivileges ( string  sDpName,
string  sClassName 
)

Update the recipe instances privileges.

Parameters
sDpName- [IN] DP name of the recipe instance.
sClassName- [IN] Recipe class name.

◆ unRecipeFunctions_arrangeRecipeInstancePrivileges()

void unRecipeFunctions_arrangeRecipeInstancePrivileges ( string  sDefaultOperatorPrivileges,
string  sDefaultExpertPrivileges,
string  sDefaultAdminPrivileges,
string &  sDeviceOperatorPrivileges,
string &  sDeviceExpertPrivileges,
string &  sDeviceAdminPrivileges 
)

Adds the unassigned privileges and removes the obsolete ones.

Parameters
sDefaultOperatorPrivileges- [IN] Default operator privileges.
sDefaultExpertPrivileges- [IN] Default expert privileges.
sDefaultAdminPrivileges- [IN] Default admin privileges.
sDeviceOperatorPrivileges- [IN/OUT] Device operator privileges.
sDeviceExpertPrivileges- [IN/OUT] Device expert privileges.
sDeviceAdminPrivileges- [IN/OUT] Device admin privileges.

◆ _unRecipeFunctions_addPrivileges()

void _unRecipeFunctions_addPrivileges ( dyn_string  dsDefaultPrivileges,
dyn_string &  dsDevicePrivileges1,
dyn_string  dsDevicePrivileges2,
dyn_string  dsDevicePrivileges3 
)
private

Auxiliary function to add the default privileges to the privileges list. If none of the dyn_strings (dsDevicePrivileges1, dsDevicePrivileges2, dsDevicePrivileges3) contains the privileges included in dsDefaultPrivileges, the privilege will be added to dsDevicePrivileges1. Otherwise (the privilege is included in any dyn_string) no actions will be done.

Parameters
dsDefaultPrivileges- [IN] The list of privileges to add.
dsDevicePrivileges1- [OUT] The list where add the privileges if they don't exist in any dyn_string.
dsDevicePrivileges2- [IN] Device privileges list.
dsDevicePrivileges3- [IN] Device privileges list.

◆ _unRecipeFunctions_removeObsoletePrivileges()

void _unRecipeFunctions_removeObsoletePrivileges ( dyn_string &  dsDevicePrivileges,
dyn_string  dsDefaultPrivileges1,
dyn_string  dsDefaultPrivileges2,
dyn_string  dsDefaultPrivileges3 
)
private

Auxiliary function to remove the obsolete privileges from the privileges list.

Parameters
dsDevicePrivileges- [OUT] List where the obsolete parameters will be removed.
dsDefaultPrivileges1- [IN] Default privileges list 1 (e.g. operator).
dsDefaultPrivileges2- [IN] Default privileges list 2 (e.g. expert).
dsDefaultPrivileges3- [IN] Default privileges list 3 (e.g. admin).

◆ unRecipeFunctions_getRecipeInstancePredefinedPrivileges()

void unRecipeFunctions_getRecipeInstancePredefinedPrivileges ( string  sClassName,
string &  sRcpInstanceDp,
string &  sAcDomain,
string &  sOperatorAction,
string &  sExpertAction,
string &  sAdminAction 
)

Gets the predefined privileges for a recipe instance based on the recipe class privileges.

Parameters
sClassName- [IN] Recipe class name
sRcpInstanceDp- [OUT] Datapoint name of the predefined recipe instance
sAcDomain- [OUT] Access control domain
sOperatorAction- [OUT] Operator privileges
sExpertAction- [OUT] Expert privileges
sAdminAction- [OUT] Admin privileges

◆ unRecipeFunctions_editRecipeClassPrivileges()

void unRecipeFunctions_editRecipeClassPrivileges ( string  sRcpClassDp)

Open a new window to edit the recipe class privileges and parameters.

Parameters
sRcpClassDp- [IN] The recipe class DP.

◆ _unRecipeFunctions_getDevicePrivileges()

void _unRecipeFunctions_getDevicePrivileges ( string  sDpName,
string &  sAcDomain,
string &  sOperatorAction,
string &  sExpertAction,
string &  sAdminAction 
)
private

Auxiliary function to get the device privileges.

Parameters
sDpName- [IN] Datapoint name of the device.
sAcDomain- [OUT] Access control domain for the device.
sOperatorAction- [OUT] Privileged actions for the operator.
sExpertAction- [OUT] Privileged actions for the expert.
sAdminAction- [OUT] Privileged actions for the admin.

◆ _unRecipeFunctions_setDevicePrivileges()

void _unRecipeFunctions_setDevicePrivileges ( string  sDpName,
string  sAcDomain,
string  sOperatorAction,
string  sExpertAction,
string  sAdminAction 
)
private

Auxiliary function to set the device privileges.

Parameters
sDpName- [IN] Datapoint name of the device.
sAcDomain- [IN] Access control domain for the device.
sOperatorAction- [IN] Privileged actions for the operator.
sExpertAction- [IN] Privileged actions for the expert.
sAdminAction- [IN] Privileged actions for the admin.

◆ unRecipeFunctions_getDefaultClassPrivileges()

void unRecipeFunctions_getDefaultClassPrivileges ( string  sRoleType,
dyn_string &  dsPrivileges 
)

Function used to get the default privileges for the recipe class actions.

Parameters
sRoleType- [IN] Role type (operator, expert or admin).
dsPrivileges- [OUT] List of default privileged actions for the specified role.

◆ unRecipeFunctions_getDefaultInstancePrivileges()

void unRecipeFunctions_getDefaultInstancePrivileges ( string  sRoleType,
dyn_string &  dsPrivileges 
)

Function used to get the default privileges for the recipe instance actions.

Parameters
sRoleType- [IN] Role type (operator, expert or admin).
dsPrivileges- [OUT] List of default privileged actions for the specified role.