otsdaq-utilities  3.02.00
ots::ConfigurationGUISupervisor Class Reference

#include <otsdaq-utilities/ConfigurationGUI/ConfigurationGUISupervisor.h>

+ Inheritance diagram for ots::ConfigurationGUISupervisor:
+ Collaboration diagram for ots::ConfigurationGUISupervisor:

Public Member Functions

 ConfigurationGUISupervisor (xdaq::ApplicationStub *s)
 
void init (void)
 
void destroy (void)
 
virtual void defaultPage (xgi::Input *in, xgi::Output *out) override
 
virtual void request (const std::string &requestType, cgicc::Cgicc &cgiIn, HttpXmlDocument &xmlOut, const WebUsers::RequestUserInfo &userInfo) override
 
virtual void setSupervisorPropertyDefaults (void) override
 
virtual void forceSupervisorPropertyValues (void) override
 override to force supervisor property values (and ignore user settings) More...
 
- Public Member Functions inherited from ots::CoreSupervisorBase
virtual void nonXmlRequest (const std::string &requestType, cgicc::Cgicc &cgiIn, std::ostream &out, const WebUsers::RequestUserInfo &userInfo)
 
virtual std::string getStatusProgressDetail (void)
 
void stateMachineXgiHandler (xgi::Input *in, xgi::Output *out)
 
void sendAsyncExceptionToGateway (const std::string &errMsg, bool isPauseException, bool isStopException)
 
virtual void stateInitial (toolbox::fsm::FiniteStateMachine &fsm)
 
virtual void statePaused (toolbox::fsm::FiniteStateMachine &fsm)
 
virtual void stateRunning (toolbox::fsm::FiniteStateMachine &fsm)
 
virtual void stateHalted (toolbox::fsm::FiniteStateMachine &fsm)
 
virtual void stateConfigured (toolbox::fsm::FiniteStateMachine &fsm)
 
virtual void transitionHalting (toolbox::Event::Reference event)
 
virtual void transitionInitializing (toolbox::Event::Reference event)
 
- Public Member Functions inherited from ots::SOAPMessenger
std::string send (XDAQ_CONST_CALL xdaq::ApplicationDescriptor *d, xoap::MessageReference message)
 
- Public Member Functions inherited from ots::CorePropertySupervisorBase
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getGatewaySupervisorDescriptor (void)
 
void getRequestUserInfo (WebUsers::RequestUserInfo &requestUserInfo)
 
ConfigurationTree getSupervisorTreeNode (void)
 
void loadUserSupervisorProperties (void)
 
std::string getSupervisorProperty (const std::string &propertyName)
 
std::string getSupervisorProperty (const std::string &propertyName, const std::string &defaultValue)
 
WebUsers::permissionLevel_t getSupervisorPropertyUserPermissionsThreshold (const std::string &requestType)
 
- Public Member Functions inherited from ots::RunControlStateMachine
virtual void stateShutdown (toolbox::fsm::FiniteStateMachine &)
 
xoap::MessageReference runControlMessageHandler (xoap::MessageReference message)
 

Static Public Member Functions

static xdaq::Application * instantiate (xdaq::ApplicationStub *s)
 
- Static Public Member Functions inherited from ots::CorePropertySupervisorBase
static void extractPermissionsMapFromString (const std::string &permissionsString, std::map< std::string, WebUsers::permissionLevel_t > &permissionsMap)
 
static bool doPermissionsGrantAccess (std::map< std::string, WebUsers::permissionLevel_t > &permissionLevelsMap, std::map< std::string, WebUsers::permissionLevel_t > &permissionThresholdsMap)
 

Additional Inherited Members

- Protected Attributes inherited from ots::CoreSupervisorBase
std::vector< bool > stateMachinesIterationDone_
 
- Protected Attributes inherited from ots::CorePropertySupervisorBase
ITRACEControllertheTRACEController_
 

Detailed Description

ConfigurationGUISupervisor This class handles the user requests to read and write the Configuration Tree.

Definition at line 13 of file ConfigurationGUISupervisor.h.

Constructor & Destructor Documentation

◆ ConfigurationGUISupervisor()

ConfigurationGUISupervisor::ConfigurationGUISupervisor ( xdaq::ApplicationStub *  stub)

new user gets a table mgr assigned user can fill any of the tables (fill from version or init empty), which becomes the active view for that table

Definition at line 40 of file ConfigurationGUISupervisor.cc.

Member Function Documentation

◆ forceSupervisorPropertyValues()

void ConfigurationGUISupervisor::forceSupervisorPropertyValues ( void  )
overridevirtual

override to force supervisor property values (and ignore user settings)

forceSupervisorPropertyValues override to force supervisor property values (and ignore user settings)

Reimplemented from ots::CorePropertySupervisorBase.

Definition at line 148 of file ConfigurationGUISupervisor.cc.

◆ instantiate()

xdaq::Application * ConfigurationGUISupervisor::instantiate ( xdaq::ApplicationStub *  stub)
static

the XDAQ_INSTANTIATOR_IMPL(ns1::ns2::...) macro needs to be put into the implementation file (.cc) of the XDAQ application

Definition at line 31 of file ConfigurationGUISupervisor.cc.

◆ setSupervisorPropertyDefaults()

void ConfigurationGUISupervisor::setSupervisorPropertyDefaults ( void  )
overridevirtual

When overriding, setup default property values here called by CoreSupervisorBase constructor

Reimplemented from ots::CorePropertySupervisorBase.

Definition at line 129 of file ConfigurationGUISupervisor.cc.


The documentation for this class was generated from the following files: