tdaq-develop-2025-02-12
Public Member Functions | List of all members
ots::AllSupervisorInfo Class Reference

#include <otsdaq/SupervisorInfo/AllSupervisorInfo.h>

Inheritance diagram for ots::AllSupervisorInfo:
ots::SupervisorDescriptorInfoBase

Public Member Functions

 AllSupervisorInfo (xdaq::ApplicationContext *applicationContext)
 
void init (xdaq::ApplicationContext *applicationContext)
 
void destroy (void)
 
bool isWizardMode (void) const
 BOOLs.
 
bool isMacroMakerMode (void) const
 
void setSupervisorStatus (xdaq::Application *app, const std::string &status, const unsigned int progress=100, const std::string &detail="", std::vector< SupervisorInfo::SubappInfo > subapps={})
 SETTERs.
 
void setSupervisorStatus (const SupervisorInfo &appInfo, const std::string &status, const unsigned int progress=100, const std::string &detail="", std::vector< SupervisorInfo::SubappInfo > subapps={})
 
void setSupervisorStatus (const unsigned int &id, const std::string &status, const unsigned int progress=100, const std::string &detail="", std::vector< SupervisorInfo::SubappInfo > subapps={})
 
void clearSupervisorSubappsStatus (const SupervisorInfo &appInfo)
 
const std::map< unsigned int, SupervisorInfo > & getAllSupervisorInfo (void) const
 GETTERs (so searching and iterating is easier)
 
const SupervisorInfoMap & getAllFETypeSupervisorInfo (void) const
 
const SupervisorInfoMap & getAllDMTypeSupervisorInfo (void) const
 
const SupervisorInfoMap & getAllLogbookTypeSupervisorInfo (void) const
 
const SupervisorInfoMap & getAllMacroMakerTypeSupervisorInfo (void) const
 
const std::map< std::string, const SupervisorInfo & > & getAllTraceControllerSupervisorInfo (void) const
 
const SupervisorInfo & getSupervisorInfo (xdaq::Application *app) const
 
const SupervisorInfo & getGatewayInfo (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getGatewayDescriptor (void) const
 
const SupervisorInfo & getWizardInfo (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getWizardDescriptor (void) const
 
const SupervisorInfo & getArtdaqSupervisorInfo (void) const
 
std::vector< std::vector< const SupervisorInfo * > > getOrderedSupervisorDescriptors (const std::string &stateMachineCommand, bool onlyGatewayContextSupervisors=false) const
 
std::recursive_mutex & getSupervisorInfoMutex (unsigned int lid)
 
- Public Member Functions inherited from ots::SupervisorDescriptorInfoBase
const SupervisorDescriptors & getDataManagerDescriptors (void) const
 
const SupervisorDescriptors & getFEDescriptors (void) const
 
const SupervisorDescriptors & getDTCDescriptors (void) const
 
const SupervisorDescriptors & getFEDataManagerDescriptors (void) const
 
const SupervisorDescriptors & getARTDAQFEDataManagerDescriptors (void) const
 
const SupervisorDescriptors & getARTDAQDataManagerDescriptors (void) const
 
const SupervisorDescriptors & getARTDAQBuilderDescriptors (void) const
 
const SupervisorDescriptors & getARTDAQDataLoggerDescriptors (void) const
 
const SupervisorDescriptors & getARTDAQDispatcherDescriptors (void) const
 
const SupervisorDescriptors & getVisualDescriptors (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getSupervisorDescriptor (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getLogbookDescriptor (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getWizardDescriptor (void) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getDataManagerDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getFEDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getDTCDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getFEDataManagerDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getARTDAQFEDataManagerDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getARTDAQDataManagerDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getARTDAQBuilderDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getARTDAQDataLoggerDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getARTDAQDispatcherDescriptor (xdata::UnsignedIntegerT instance) const
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * getVisualDescriptor (xdata::UnsignedIntegerT instance) const
 
std::string getFEURL (xdata::UnsignedIntegerT instance) const
 
 SupervisorDescriptorInfoBase (xdaq::ApplicationContext *applicationContext)
 

Additional Inherited Members

- Protected Member Functions inherited from ots::SupervisorDescriptorInfoBase
const SupervisorDescriptors & getAllDescriptors (void) const
 
- Protected Attributes inherited from ots::SupervisorDescriptorInfoBase
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * theSupervisor_
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * theWizard_
 
XDAQ_CONST_CALL xdaq::ApplicationDescriptor * theLogbookSupervisor_
 
SupervisorDescriptors theVisualSupervisors_
 
SupervisorDescriptors theDataManagerSupervisors_
 
SupervisorDescriptors theFESupervisors_
 
SupervisorDescriptors theDTCSupervisors_
 
SupervisorDescriptors theFEDataManagerSupervisors_
 
SupervisorDescriptors theARTDAQFEDataManagerSupervisors_
 
SupervisorDescriptors theARTDAQDataManagerSupervisors_
 
SupervisorDescriptors theARTDAQBuilderSupervisors_
 
SupervisorDescriptors theARTDAQDataLoggerSupervisors_
 
SupervisorDescriptors theARTDAQDispatcherSupervisors_
 
SupervisorDescriptors allSupervisors_
 

Detailed Description

class define AllSupervisorInfo xdaq Supervisors can use this class to gain access to info for all supervisors in the xdaq Context. Supervisors are organized by type/class. Note that if a supervisor is encountered in the xdaq context that is of unknown type, then it is ignored and not organized.

Supervisors should call init to setup data members of this class.

This class, when in normal mode, also interprets the active configuration to associate configuration UID/names to the supervisors in the xdaq context. In wizard mode, UID/name is taken from class name.

Definition at line 30 of file AllSupervisorInfo.h.

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