Mix-in for container classes that manage variable publishing. More...

#include <MQwPublishable.h>

Inheritance diagram for MQwPublishable< U, T >:

Collaboration diagram for MQwPublishable< U, T >:

Public Member Functions
	MQwPublishable ()
	Default constructor Initializes empty variable publishing maps.

	MQwPublishable (const MQwPublishable &source)
	Copy constructor Creates a new container with cleared publishing maps (variables are not copied).

virtual	~MQwPublishable ()
	Virtual destructor.

Bool_t	RequestExternalValue (const TString &name, VQwHardwareChannel *value) const
	Retrieve a variable value from external sources by copying Searches for the named variable in external subsystem arrays and copies its value into the provided data element.

const VQwHardwareChannel *	RequestExternalPointer (const TString &name) const
	Retrieve a direct pointer to an external variable Searches for the named variable in external subsystem arrays and returns a direct pointer to the data element.

virtual const VQwHardwareChannel *	ReturnInternalValue (const TString &name) const
	Retrieve an internal variable by name (pointer version) Searches for the named variable among published internal variables and returns a direct pointer to the data element.

Bool_t	ReturnInternalValue (const TString &name, VQwHardwareChannel *value) const
	Retrieve an internal variable by name (copy version) Searches for the named variable among published internal variables and copies its value into the provided data element.

void	ListPublishedValues () const
	List all published variables with descriptions Prints a summary of all currently published variables and their descriptions to the logging output for debugging and inspection purposes.

Bool_t	PublishInternalValue (const TString name, const TString desc, const T subsys, const VQwHardwareChannel element)
	Publish an internal variable from a subsystem Registers a variable from one of the contained subsystems in the publishing framework, making it available for external access by name.

Data Fields
std::vector< std::vector< TString > >	fPublishList

Private Member Functions
virtual Bool_t	PublishByRequest (TString device_name)
	Try to publish an internal variable on demand Called internally when a variable is requested but not yet published. Iterates through contained subsystems to find and publish the requested variable.

Private Attributes
std::map< TString, const VQwHardwareChannel * >	fPublishedValuesDataElement
	Published values.

std::map< TString, const T * >	fPublishedValuesSubsystem

std::map< TString, TString >	fPublishedValuesDescription

Detailed Description

template<class U, class T>
class MQwPublishable< U, T >

Mix-in for container classes that manage variable publishing.

Provides the container-side logic for the variable publishing system, including registering published variables, handling external requests, and maintaining mappings between variable names and data elements.

Definition at line 116 of file MQwPublishable.h.

Constructor & Destructor Documentation

◆ MQwPublishable() [1/2]

template<class U, class T>

MQwPublishable< U, T >::MQwPublishable ( )

inline

Default constructor Initializes empty variable publishing maps.

Definition at line 124 of file MQwPublishable.h.

124{ };

Referenced by MQwPublishable(), and ReturnInternalValue().

Here is the caller graph for this function:

◆ MQwPublishable() [2/2]

template<class U, class T>

MQwPublishable< U, T >::MQwPublishable ( const MQwPublishable< U, T > & source )

inline

Copy constructor Creates a new container with cleared publishing maps (variables are not copied).

Parameters

source Source object to copy from (maps are cleared, not copied)

Definition at line 131 of file MQwPublishable.h.

                                                 {
      fPublishedValuesDataElement.clear();
      fPublishedValuesSubsystem.clear();
      fPublishedValuesDescription.clear();
    }

References fPublishedValuesDataElement, fPublishedValuesDescription, fPublishedValuesSubsystem, and MQwPublishable().

Here is the call graph for this function:

◆ ~MQwPublishable()

template<class U, class T>

virtual MQwPublishable< U, T >::~MQwPublishable ( )

inlinevirtual

Virtual destructor.

Definition at line 138 of file MQwPublishable.h.

138{ };

Member Function Documentation

◆ ListPublishedValues()

template<class U, class T>

void MQwPublishable< U, T >::ListPublishedValues ( ) const

List all published variables with descriptions Prints a summary of all currently published variables and their descriptions to the logging output for debugging and inspection purposes.

Definition at line 141 of file MQwPublishable.cc.

{
  QwOut << "List of published values:" << QwLog::endl;
  std::map<TString,TString>::const_iterator iter;
  for (iter  = fPublishedValuesDescription.begin();
       iter != fPublishedValuesDescription.end(); iter++) {
    QwOut << iter->first << ": " << iter->second << QwLog::endl;
  }
}

References QwLog::endl(), fPublishedValuesDescription, and QwOut.

Referenced by main(), PublishByRequest(), and PublishInternalValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PublishByRequest()

template<class U, class T>

Bool_t MQwPublishable< U, T >::PublishByRequest ( TString device_name )

privatevirtual

Try to publish an internal variable on demand Called internally when a variable is requested but not yet published. Iterates through contained subsystems to find and publish the requested variable.

Parameters

device_name Name of the variable being requested

Returns: kTRUE if the variable was found and published, kFALSE otherwise

Definition at line 111 of file MQwPublishable.cc.

{
  Bool_t status = kFALSE;
  if (fPublishedValuesSubsystem.count(device_name) > 0) {
    QwDebug << "MQwPublishable::PublishByRequest:  Channel "
            << device_name << " has already been published."
            << QwLog::endl;
    ListPublishedValues();
    status = kTRUE;
  } else {
    U* u = dynamic_cast<U*>(this);
    if (not u->empty()) {
      for (auto subsys = u->begin(); subsys != u->end(); ++subsys)
      {
        status = (*subsys)->PublishByRequest(device_name);
        if (status) break;
      }
      // Report failure to publish
      if (! status) {
        QwDebug << "MQwPublishable::PublishByRequest: Failed to publish channel name: "
        << device_name << QwLog::endl;
      }
    }
  }
  return status;
}

References QwLog::endl(), fPublishedValuesSubsystem, ListPublishedValues(), and QwDebug.

Referenced by ReturnInternalValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PublishInternalValue()

template<class U, class T>

Bool_t MQwPublishable< U, T >::PublishInternalValue	(	const TString	name,
		const TString	desc,
		const T *	subsys,
		const VQwHardwareChannel *	element )

Publish an internal variable from a subsystem Registers a variable from one of the contained subsystems in the publishing framework, making it available for external access by name.

Parameters

name	Unique name/key for the variable
desc	Human-readable description of the variable
subsys	Pointer to the subsystem that owns this variable
element	Pointer to the data element representing this variable

Returns: kTRUE if variable was successfully published, kFALSE if name already exists

Definition at line 92 of file MQwPublishable.cc.

{
  if (fPublishedValuesSubsystem.count(name) > 0) {
    QwError << "Attempting to publish existing variable key!" << QwLog::endl;
    ListPublishedValues();
    return kFALSE;
  }
  fPublishedValuesSubsystem[name] = subsys;
  fPublishedValuesDescription[name] = desc;
  fPublishedValuesDataElement[name] = element;
  return kTRUE;
}

References QwLog::endl(), fPublishedValuesDataElement, fPublishedValuesDescription, fPublishedValuesSubsystem, ListPublishedValues(), and QwError.

Here is the call graph for this function:

◆ RequestExternalPointer()

template<class U, class T>

const VQwHardwareChannel * MQwPublishable< U, T >::RequestExternalPointer ( const TString & name ) const

Retrieve a direct pointer to an external variable Searches for the named variable in external subsystem arrays and returns a direct pointer to the data element.

Parameters

name	Name of the variable to retrieve

Returns: Pointer to the variable's data element, or nullptr if not found

Definition at line 24 of file MQwPublishable.cc.

{
  //  If this has a parent, we should escalate the call to that object,
  //  but so far we don't have that capability.
  return ReturnInternalValue(name);
}

References ReturnInternalValue().

Referenced by LRBCorrector::ConnectChannels(), QwCombiner::ConnectChannels(), QwCorrelator::ConnectChannels(), VQwDataHandler::ConnectChannels(), and QwBlinder::Update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RequestExternalValue()

template<class U, class T>

Bool_t MQwPublishable< U, T >::RequestExternalValue	(	const TString &	name,
		VQwHardwareChannel *	value ) const

Retrieve a variable value from external sources by copying Searches for the named variable in external subsystem arrays and copies its value into the provided data element.

Parameters

name	Name of the variable to retrieve
value	Pointer to data element that will receive the variable's value

Returns: kTRUE if variable was found and copied, kFALSE otherwise

Definition at line 16 of file MQwPublishable.cc.

{
  //  If this has a parent, we should escalate the call to that object,
  //  but so far we don't have that capability.
  return ReturnInternalValue(name, value);
}

References ReturnInternalValue().

Here is the call graph for this function:

◆ ReturnInternalValue() [1/2]

template<class U, class T>

const VQwHardwareChannel * MQwPublishable< U, T >::ReturnInternalValue ( const TString & name ) const

virtual

Retrieve an internal variable by name (pointer version) Searches for the named variable among published internal variables and returns a direct pointer to the data element.

Parameters

name	Name of the variable to retrieve

Returns: Pointer to the variable's data element, or nullptr if not found

Definition at line 34 of file MQwPublishable.cc.

{
  //  First try to find the value in the list of published values.
  std::map<TString, const VQwHardwareChannel*>::const_iterator iter1 =
      fPublishedValuesDataElement.find(name);
  if (iter1 != fPublishedValuesDataElement.end()) {
    return iter1->second;
  }
  /*
  //  Second, ask the subsystem that has claimed the value
  typename std::map<TString, const T*>::const_iterator iter2 =
      fPublishedValuesSubsystem.find(name);
  if (iter2 != fPublishedValuesSubsystem.end()) {
    return (iter2->second)->ReturnInternalValue(name);
  }
  */
  //  If the value is not yet published, try requesting it.
  if (const_cast<MQwPublishable*>(this)->PublishByRequest(name)){
    iter1 = fPublishedValuesDataElement.find(name);
    if (iter1 != fPublishedValuesDataElement.end()) {
      return iter1->second;
    }
    QwError << "PublishByRequest succeeded, but can't find the record for "
            << name << QwLog::endl;
 
  } else {
    QwDebug << "PublishByRequest failed for " << name << QwLog::endl;
  }
  //  Not found
  return 0;
}

References QwLog::endl(), fPublishedValuesDataElement, MQwPublishable(), PublishByRequest(), QwDebug, and QwError.

Referenced by QwAlarmHandler::ConnectChannels(), RequestExternalPointer(), and RequestExternalValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReturnInternalValue() [2/2]

template<class U, class T>

Bool_t MQwPublishable< U, T >::ReturnInternalValue	(	const TString &	name,
		VQwHardwareChannel *	value ) const

Retrieve an internal variable by name (copy version) Searches for the named variable among published internal variables and copies its value into the provided data element.

Parameters

name	Name of the variable to retrieve
value	Pointer to data element that will receive the variable's value

Returns: kTRUE if variable was found and copied, kFALSE otherwise

Definition at line 68 of file MQwPublishable.cc.

{
  Bool_t foundit = kFALSE;
 
  // Check for null pointer
  if (! value)
    QwWarning << "MQwPublishable::ReturnInternalValue requires that "
              << "'value' be a non-null pointer to a VQwHardwareChannel."
              << QwLog::endl;
 
  //  Get a const pointer to the internal value
  const VQwHardwareChannel* internal_value = ReturnInternalValue(name);
  if (value && internal_value) {
    value->AssignValueFrom(internal_value);
    foundit = kTRUE;
  } else
    QwWarning << "MQwPublishable::ReturnInternalValue: name \""
              << name << "\" not found in array." << QwLog::endl;
 
  return foundit;
}

Field Documentation

◆ fPublishedValuesDataElement

template<class U, class T>

std::map<TString, const VQwHardwareChannel*> MQwPublishable< U, T >::fPublishedValuesDataElement

private

Published values.

Definition at line 215 of file MQwPublishable.h.

Referenced by MQwPublishable(), PublishInternalValue(), and ReturnInternalValue().

◆ fPublishedValuesDescription

template<class U, class T>

std::map<TString, TString> MQwPublishable< U, T >::fPublishedValuesDescription

private

Definition at line 217 of file MQwPublishable.h.

Referenced by ListPublishedValues(), MQwPublishable(), and PublishInternalValue().

◆ fPublishedValuesSubsystem

template<class U, class T>

std::map<TString, const T*> MQwPublishable< U, T >::fPublishedValuesSubsystem

private

Definition at line 216 of file MQwPublishable.h.

Referenced by MQwPublishable(), PublishByRequest(), and PublishInternalValue().

◆ fPublishList

template<class U, class T>

std::vector<std::vector<TString> > MQwPublishable< U, T >::fPublishList

Definition at line 141 of file MQwPublishable.h.

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

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MQwPublishable() [1/2]

◆ MQwPublishable() [2/2]

◆ ~MQwPublishable()

Member Function Documentation

◆ ListPublishedValues()

◆ PublishByRequest()

◆ PublishInternalValue()

◆ RequestExternalPointer()

◆ RequestExternalValue()

◆ ReturnInternalValue() [1/2]

◆ ReturnInternalValue() [2/2]

Field Documentation

◆ fPublishedValuesDataElement

◆ fPublishedValuesDescription

◆ fPublishedValuesSubsystem

◆ fPublishList