SignalStateHelper Class Reference

#include <SignalStateHelper.h>

Collaboration diagram for SignalStateHelper:

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

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

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 24 of file SignalStateHelper.h.

Constructor & Destructor Documentation

SignalStateHelper() [1/4]

SignalStateHelper::SignalStateHelper

(

)

Empty Constructor.

Definition at line 21 of file SignalStateHelper.cxx.

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

SignalStateHelper() [2/4]

SignalStateHelper::SignalStateHelper

(

ISignalState *

theObject

)

Constructor with initialization.

Definition at line 28 of file SignalStateHelper.cxx.

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

SignalStateHelper() [3/4]

SignalStateHelper::SignalStateHelper

(

P4SignalState::State

s

)

Definition at line 36 of file SignalStateHelper.cxx.

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

SignalStateHelper() [4/4]

SignalStateHelper::SignalStateHelper	(	ISignalState *	theObject,
		P4SignalState::State	s
	)

Definition at line 44 of file SignalStateHelper.cxx.

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

~SignalStateHelper()

SignalStateHelper::~SignalStateHelper

(

)

Destructor.

Definition at line 55 of file SignalStateHelper.cxx.

{
  releaseObject();
}

Member Function Documentation

controlObject()

bool SignalStateHelper::controlObject

(

ISignalState *

theObject

)

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

Change the object controlled.

Definition at line 61 of file SignalStateHelper.cxx.

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

releaseObject()

bool SignalStateHelper::releaseObject

(

)

Release controled object (this resets its signal state)

Definition at line 83 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 SignalStateHelper::resetSignalState

(

)

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

Definition at line 95 of file SignalStateHelper.cxx.

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

setSignalState()

bool SignalStateHelper::setSignalState

(

P4SignalState::State

s

)

Change the signal state for future operations.

Definition at line 71 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 SignalStateHelper::m_currentState

protected

Definition at line 55 of file SignalStateHelper.h.

m_object

ISignalState* SignalStateHelper::m_object

protected

Pointer to the owned object.

Definition at line 58 of file SignalStateHelper.h.

m_originalState

P4SignalState::State SignalStateHelper::m_originalState

protected

Storage of the states.

Definition at line 54 of file SignalStateHelper.h.

---

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

• SignalStateHelper.h
• SignalStateHelper.cxx