fwSystemOverview  8.4.1
fwSystemOverviewFunc.ctl File Reference
bool flagGetHost = true
 
string fwSystemOverviewFunc_getStrFromState (int stat)
 
int fwSystemOverviewFunc_setProjPmonNotRunning (string projDp)
 
int fwSystemOverviewFunc_setProjPmonNotResponding (string projDp)
 
int fwSystemOverviewFunc_getProjManagersData (string projDp, dyn_string &type, dyn_int &num, dyn_string &opt, dyn_uint &mode, dyn_uint &index, dyn_int &cStat, dyn_int &okStat, dyn_int &pid, dyn_uint &resetMin, dyn_uint &restart, dyn_uint &secKill, dyn_time &startTime, dyn_bool &lastUpdated)
 
int fwSystemOverviewFunc_getProjAccessData (string projDp, string &hostName, unsigned &pmonPortNo, string &userName, string &userPassword, string &sharedDir)
 
int fwSystemOverviewFunc_getProjDPList (string sysDp, dyn_string &projDpList)
 
string fwSystemOverviewFunc_sysNoToDp (unsigned sysNo)
 
int fwSystemOverviewFunc_getSysData (string sysDp, unsigned &sysNo, string &sysName, unsigned &parentNo, dyn_uint &childNodes, dyn_string &projDpList)
 

Detailed Description

This library contains functions associated with the JCOP Framework System Overview tool. The functions read the configuration file and build a hierarchy of systems and projects within each system. Then the Projects are polled simultaneously via the PMON port and the managers information and states are updated in datapoint

Creation Date
15/02/2007
Modification History
Constraints
fwSystemOverview_readConfigFile has to be used to create the data point structure, upon which rest of the functions act
Author
Kuldeep Joshi (BARC, India) kulde.nosp@m.ep.j.nosp@m.oshi@.nosp@m.gmai.nosp@m.l.com

Function Documentation

string fwSystemOverviewFunc_getStrFromState ( int  stat)
Converts state in integer format to a string format. 
NOTE: By modifying this function one can add additional states
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
statInteger state
int fwSystemOverviewFunc_setProjPmonNotRunning ( string  projDp)
Sets the projects current state as PMON_NOT_RUNNING
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
projDpProject datapoint name
int fwSystemOverviewFunc_setProjPmonNotResponding ( string  projDp)
Sets the projects current state as PMON_NOT_RESPONDING
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
projDpProject datapoint name
int fwSystemOverviewFunc_getProjManagersData ( string  projDp,
dyn_string &  type,
dyn_int &  num,
dyn_string &  opt,
dyn_uint &  mode,
dyn_uint &  index,
dyn_int &  cStat,
dyn_int &  okStat,
dyn_int &  pid,
dyn_uint &  resetMin,
dyn_uint &  restart,
dyn_uint &  secKill,
dyn_time &  startTime,
dyn_bool &  lastUpdated 
)
Gets all the information about the managers in project. 
Note: The relation between data from all the arrays is based on the Index of the array.
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
projDpProject datapoint name
typeArray of manager types
numArray of manager number
optArray of manager options
modeArray of manager startup mode
indexArray of managet index
cStatArray of current state of managers
okStatArray of Ok States of manager as defined in the configuration file. This array can be shorter than the other arrays
pidArray of process ids of manager
resetMinArray of reset start counter for manager
restartArray of restart for manager
secKillArray of Seconds to Kill for manager
startTimeArray of start time for manager
lastUpdatedArray of flags that indicated if the manager was updated during the last PMON scan
int fwSystemOverviewFunc_getProjAccessData ( string  projDp,
string &  hostName,
unsigned &  pmonPortNo,
string &  userName,
string &  userPassword,
string &  sharedDir 
)
Gets Access data for polling the project
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
projDpProject datapoint name
hostNameHost machine name on which the project is running
pmonPortNoPort number of the PMON port
userNameUser name which has access priviledge to the PMON
userPasswordPassword for the user
sharedDirShared directory path for the project folder
int fwSystemOverviewFunc_getProjDPList ( string  sysDp,
dyn_string &  projDpList 
)
Get project datapoint names registered for a system
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
sysDpSystem Datapoint name
projDpListArray of project datapoint names
string fwSystemOverviewFunc_sysNoToDp ( unsigned  sysNo)
Convert system number to datapoint name
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
sysNoSystem number
int fwSystemOverviewFunc_getSysData ( string  sysDp,
unsigned &  sysNo,
string &  sysName,
unsigned &  parentNo,
dyn_uint &  childNodes,
dyn_string &  projDpList 
)
Get system data
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
sysDpSystem datapoint name
sysNoSystem number
sysNameSystem name
parentNoParent system number
childNodesChildren nodes
projDpListProject datapoint name list

Variable Documentation

bool flagGetHost = true
Extracts the the project parameters, manager and ok state information for the project.

NOTE: This is one of the functions to read configuration information, save data in 
datapoint and initialise the data structure required by fwSystemOverview tool
Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters
projStrString which contained project parameters is parsed and the projDp datapoint is populated
sysNoThe number of the system for which the project is configured
projDpDatapoint name where the parsed project information is stored