SignalStateConstHelper Class Reference

Simple helper class which allows "safe" signal state switching. More...

#include <SignalStateHelper.h>

Collaboration diagram for SignalStateConstHelper:

Public Member Functions
	SignalStateConstHelper ()
	Empty Constructor.
	SignalStateConstHelper (const ISignalState *theObject)
	Constructor with initialization.
	SignalStateConstHelper (P4SignalState::State s)
	SignalStateConstHelper (const ISignalState *theObject, P4SignalState::State s)
	~SignalStateConstHelper ()
	Destructor.
bool	setSignalState (P4SignalState::State s)
	Change the signal state for future operations.
bool	resetSignalState ()
	Reset the Signal State of the controlled object and use it for future operations.
bool	controlObject (const ISignalState *theObject)
	Change the object controlled, this releases previous object and resets its SigState.
bool	releaseObject ()
	Release controled object (this resets its signal state)

Protected Attributes
P4SignalState::State	m_originalState
	Storage of the states.
P4SignalState::State	m_currentState
ISignalState *	m_object
	Pointer to the owned object.

Detailed Description

Simple helper class which allows "safe" signal state switching.

As soon as the helper goes out of scope, the wrapped object is returned to its original SignalState.

Author

Pierre-Antoine Delsart <delsart AT in2p3.fr>

Pier-Olivier DeViveiros <viveiros AT physics.utoronto.ca>

Definition at line 74 of file SignalStateHelper.h.

Constructor & Destructor Documentation

SignalStateConstHelper() [1/4]

SignalStateConstHelper::SignalStateConstHelper

(

)

Empty Constructor.

Definition at line 114 of file SignalStateHelper.cxx.

                                              :
  m_originalState(P4SignalState::UNKNOWN),
  m_currentState(P4SignalState::UNKNOWN),
  m_object(0)
{}

SignalStateConstHelper() [2/4]

SignalStateConstHelper::SignalStateConstHelper

(

const ISignalState *

theObject

)

Constructor with initialization.

Definition at line 121 of file SignalStateHelper.cxx.

                                                                           :
  m_originalState(P4SignalState::UNKNOWN),
  m_currentState(P4SignalState::UNKNOWN),
  m_object(0)
{  
  controlObject(theObject);
}

SignalStateConstHelper() [3/4]

SignalStateConstHelper::SignalStateConstHelper

(

P4SignalState::State

s

)

Definition at line 129 of file SignalStateHelper.cxx.

                                                                  :
  m_originalState(P4SignalState::UNKNOWN),
  m_currentState(s),
  m_object(0)
{  
  setSignalState(s);
}

SignalStateConstHelper() [4/4]

SignalStateConstHelper::SignalStateConstHelper	(	const ISignalState *	theObject,
		P4SignalState::State	s )

Definition at line 137 of file SignalStateHelper.cxx.

                                                                                                 :
  m_originalState(P4SignalState::UNKNOWN),
  m_currentState(s),
  m_object(const_cast<ISignalState*>(theObject))
{
  if( theObject != NULL ){
    m_originalState = theObject->signalState();  
    m_object->setSignalState(m_currentState);
  }
}

~SignalStateConstHelper()

SignalStateConstHelper::~SignalStateConstHelper

(

)

Destructor.

Definition at line 148 of file SignalStateHelper.cxx.

{
  releaseObject();
}

Member Function Documentation

controlObject()

bool SignalStateConstHelper::controlObject

(

const ISignalState *

theObject

)

Change the object controlled, this releases previous object and resets its SigState.

Change the object controlled.

Definition at line 154 of file SignalStateHelper.cxx.

{
  releaseObject();
  m_originalState = theObject->signalState();
  m_object = const_cast<ISignalState*>(theObject);
  if(m_currentState!=P4SignalState::UNKNOWN)
    m_object->setSignalState(m_currentState);
  return true;
}

releaseObject()

bool SignalStateConstHelper::releaseObject

(

)

Release controled object (this resets its signal state)

Definition at line 176 of file SignalStateHelper.cxx.

{
  // If we have an object attached, revert and remove
  if(m_object!=0)
    {
      m_object->setSignalState(m_originalState);
      m_object=0;
      return true;
    }
  return false;
}

resetSignalState()

bool SignalStateConstHelper::resetSignalState

(

)

Reset the Signal State of the controlled object and use it for future operations.

Definition at line 188 of file SignalStateHelper.cxx.

{
  if(m_object!=0)
    {
      m_currentState = m_originalState;
      m_object->setSignalState(m_originalState);
      return true;
    }
  return false;
}

setSignalState()

bool SignalStateConstHelper::setSignalState

(

P4SignalState::State

s

)

Change the signal state for future operations.

Definition at line 164 of file SignalStateHelper.cxx.

{
  m_currentState = s;
  // If we do have an object attached, switch its signal state
  if(m_object != 0 && m_currentState!=P4SignalState::UNKNOWN)
    {
      m_object->setSignalState(m_currentState);
      return true;
    }
  return false;
}

Member Data Documentation

m_currentState

P4SignalState::State SignalStateConstHelper::m_currentState

protected

Definition at line 105 of file SignalStateHelper.h.

m_object

ISignalState* SignalStateConstHelper::m_object

protected

Pointer to the owned object.

Definition at line 108 of file SignalStateHelper.h.

m_originalState

P4SignalState::State SignalStateConstHelper::m_originalState

protected

Storage of the states.

Definition at line 104 of file SignalStateHelper.h.

---

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

• SignalStateHelper.h
• SignalStateHelper.cxx