ots::ConsoleSupervisor Class Reference

#include <otsdaq-utilities/Console/ConsoleSupervisor.h>

Inheritance diagram for ots::ConsoleSupervisor:

Collaboration diagram for ots::ConsoleSupervisor:

Classes
struct	ConsoleMessageStruct
struct	CustomTriggeredAction_t

Public Member Functions
	XDAQ_INSTANTIATOR ()
	ConsoleSupervisor (xdaq::ApplicationStub *s)
void	init (void)
void	destroy (void)
xoap::MessageReference	resetConsoleCounts (xoap::MessageReference message)
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 std::string	getStatusProgressDetail (void) override
virtual void	forceSupervisorPropertyValues (void) override
void	doTriggeredAction (const CustomTriggeredAction_t &triggeredAction)
Public Member Functions inherited from ots::CoreSupervisorBase
virtual void	nonXmlRequest (const std::string &requestType, cgicc::Cgicc &cgiIn, std::ostream &out, const WebUsers::RequestUserInfo &userInfo)
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)
virtual void	setSupervisorPropertyDefaults (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)

Public Attributes
std::atomic< bool >	customTriggerActionThreadExists_ = false

Static Public Attributes
static const std::set< std::string >	CUSTOM_TRIGGER_ACTIONS
	Count always happens, and System Message always happens for FSM commands.

Additional Inherited Members
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)
Protected Attributes inherited from ots::CoreSupervisorBase
std::vector< bool >	stateMachinesIterationDone_
Protected Attributes inherited from ots::CorePropertySupervisorBase
ITRACEController *	theTRACEController_

Detailed Description

class define ConsoleSupervisor This class handles the presentation of Message Facility printouts to the web desktop Console.

Definition at line 20 of file ConsoleSupervisor.h.

Member Function Documentation

forceSupervisorPropertyValues()

void ConsoleSupervisor::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 1012 of file ConsoleSupervisor.cc.

getStatusProgressDetail()

std::string ConsoleSupervisor::getStatusProgressDetail ( void  )

overridevirtual

virtual progress string that can be overridden with more info like Console Error and Warning count

Reimplemented from ots::CoreSupervisorBase.

Definition at line 2000 of file ConsoleSupervisor.cc.

request()

void ConsoleSupervisor::request ( const std::string &  requestType, cgicc::Cgicc &  cgiIn, HttpXmlDocument &  xmlOut, const WebUsers::RequestUserInfo &  userInfo  )

overridevirtual

Request Handles Web Interface requests to Console supervisor. Does not refresh cookie for automatic update checks.

Reimplemented from ots::CoreSupervisorBase.

Definition at line 1023 of file ConsoleSupervisor.cc.

---

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

• otsdaq-utilities/otsdaq-utilities/Console/ConsoleSupervisor.h
• otsdaq-utilities/otsdaq-utilities/Console/ConsoleSupervisor.cc