---

FlagTxt Class Reference

Flags base that: 1. More...

#include <CalibTracker/SiStripRunSummary/interface/FlagTxt.h>

Inheritance diagram for FlagTxt:

List of all members.

Public Types
typedef std::list< FlagTxt * >	LChildren
Public Member Functions
template<class T>
FlagTxt *	createChild ()
	Method that is responsible for Child Flags creation.
	FlagTxt ()
template<class T>
FlagTxt *	getChild () const
	Search for a specific child flag of given class if there is any available among children.
template<class T>
int	getChildren (LChildren &roLChildren) const
	Search for children that are instances of the same class.
virtual bool	setState (const State &reSTATE)
	Override base setState method to update parents state.
virtual	~FlagTxt ()
Protected Member Functions
	FlagTxt (const FlagXML &roFLAGXML)
	Construct flag from another.
	FlagTxt (const FlagTxt &roFLAGTXT)
	Construct flag from another.
virtual int	isChildValid (const FlagTxt *) const
	Specify policy of current flag: can it have any children? Should be overriden by successors.
Private Types
typedef ClassIDBase::ID	FlagID
typedef std::multimap< FlagID, FlagTxt * >	MChildFlags
Private Member Functions
void	addChild (FlagTxt *poSubFlag)
	Add child flag into the container of subflags.
template<class Archive>
void	load (Archive &roArchive, const unsigned int &rnVersion)
FlagTxt &	operator= (const FlagTxt &roFLAGTXT)
	prevent copy assignment
template<class Archive>
void	save (Archive &roArchive, const unsigned int &rnVersion) const
	--[ BEGIN ]-- Serialization section: Text format
void	updateState (const State &reCHILD_STATE)
	Update parents state.
Private Attributes
MChildFlags	oMChildFlags_
FlagTxt *	poParentFlag_
	--[ END ]--
Friends
class	boost::serialization::access
	--[ BEGIN ]-- Serialization section: Text format
class	FlagXML
	Grant access of FlagXML to children.

---

Detailed Description

Flags base that: 1.

Knows how to serialize Flags Tree in text/binary formats. 2. Holds children and responsible for their creation and access. 3. Tracks Children change state in order to update state of parent. [aka recursive set State].

Definition at line 30 of file FlagTxt.h.

---

Member Typedef Documentation

typedef ClassIDBase::ID FlagTxt::FlagID [private]

Definition at line 140 of file FlagTxt.h.

typedef std::list<FlagTxt *> FlagTxt::LChildren

Definition at line 32 of file FlagTxt.h.

typedef std::multimap<FlagID,FlagTxt *> FlagTxt::MChildFlags [private]

Definition at line 141 of file FlagTxt.h.

---

Constructor & Destructor Documentation

FlagTxt::FlagTxt

(

)

[inline]

Definition at line 34 of file FlagTxt.h.

References poParentFlag_.

: Flag() { poParentFlag_ = 0; }

FlagTxt::~FlagTxt

(

)

[virtual]

Definition at line 10 of file FlagTxt.cc.

References oMChildFlags_.

                  {
  // Memory Clean Up: remove all children
  for( MChildFlags::const_iterator oIter = oMChildFlags_.begin();
       oIter != oMChildFlags_.end();
       ++oIter) {

    delete oIter->second;
  }
}

FlagTxt::FlagTxt

(

const FlagTxt &

roFLAGTXT

)

[protected]

Construct flag from another.

Used by cloneXXX().

Parameters:

roFLAGTXT

Flag to be copied.

Definition at line 32 of file FlagTxt.cc.

References addChild(), oMChildFlags_, and poParentFlag_.

  : Flag( roFLAGTXT) 
{
  poParentFlag_ = 0;

  // Clone all children.
  for( MChildFlags::const_iterator oIter = roFLAGTXT.oMChildFlags_.begin();
       oIter != roFLAGTXT.oMChildFlags_.end();
       ++oIter) {

    FlagTxt *poFlagClone = dynamic_cast<FlagTxt *>( oIter->second->clone());

    // Parent will be set by addChild(...)
    addChild( poFlagClone);
  }
}

FlagTxt::FlagTxt

(

const FlagXML &

roFLAGXML

)

[protected]

Construct flag from another.

Used by cloneXXX().

Parameters:

roFLAGXML

Flag to be copied.

Definition at line 49 of file FlagTxt.cc.

References addChild(), FlagXML::oMChildFlags_, and poParentFlag_.

  : Flag( roFLAGXML)
{
  poParentFlag_ = 0;

  // Take care of Children
  for( FlagXML::MChildFlags::const_iterator oIter = 
         roFLAGXML.oMChildFlags_.begin();
       oIter != roFLAGXML.oMChildFlags_.end();
       ++oIter) {

    FlagTxt *poNewChild = dynamic_cast<FlagTxt *>( oIter->second->cloneTxt());

    // Parent will be set by addChild(...)
    addChild( poNewChild);
  }
}

---

Member Function Documentation

void FlagTxt::addChild

(

FlagTxt *

poSubFlag

)

[private]

Add child flag into the container of subflags.

Parameters:

poSubFlag

Flag to be added

Definition at line 110 of file FlagTxt.cc.

References Identifiable::getID(), oMChildFlags_, and poParentFlag_.

Referenced by createChild(), FlagTxt(), and load().

                                          {
  poSubFlag->poParentFlag_ = this;
  oMChildFlags_.insert( std::make_pair( poSubFlag->getID(), poSubFlag));
}

template<class T>

FlagTxt * FlagTxt::createChild

(

)

[inline]

Method that is responsible for Child Flags creation.

Create child flag of desired class.

Its tasks are: 1. Check if Child Flag of given type is allowed 2. Create Child Flag in case (1.) is true 3. Set newly created child flags parent.

Returns:

>0 Pointer to newly created flag 0 Invalid pointer in case child flag of given class is not allowed.

Definition at line 201 of file FlagTxt.h.

References addChild(), ClassID< T >::get(), Flag::getState(), isChildValid(), and updateState().

Referenced by getTXTFlagTree().

                                {
    FlagTxt *poResult = 0;
    
    try {
      // Create object of requested class: may throw exception
      FlagTxt *poFlag = new T();

      // Get number of allowed children
      int nChildFlags = isChildValid( poFlag);

      FlagID nID = ClassID<T>::get();

      switch( nChildFlags) {
        case 0:
          // No child flags allowed
          delete poFlag;
          break;
        case -1:
          // No limit on child flags
          {
            // Parent will be set by addChild(...)
            addChild( poFlag);

            // Update parent state: child may be put into ERROR state by 
            // default (this is specified in Flag class). Unfortunately
            // parent won't be updated
            updateState( poFlag->getState());

            poResult = poFlag;
          }
          break;
        default:
          // All other cases
          {
            if( 0 < nChildFlags) {
              // Check if Flag already exists
              std::pair<MChildFlags::const_iterator, 
                        MChildFlags::const_iterator> oFoundChildren = 
                oMChildFlags_.equal_range( nID);

              if( nChildFlags > std::distance( oFoundChildren.first,
                                               oFoundChildren.second)) {

                // Parent will be set by addChild(...)
                addChild( poFlag);

                // Update parent state: child may be put into ERROR state by 
                // default (this is specified in Flag class). Unfortunately
                // parent won't be updated
                updateState( poFlag->getState());

                poResult = poFlag;
              } else {
                // No more child tags are allowed
                delete poFlag;
              }
            } else {
              // Unsupported value of child flags returned
              delete poFlag;
            }// End check if nChildFlags is positive
          }
          break;
      } // End switch( nChildFlags)
    } catch(...) {
      // Ups, trying to create child of Flag that is not inherited from
      // given class :[
    }

    return poResult;
  }

template<class T>

FlagTxt * FlagTxt::getChild

(

)

const [inline]

Search for a specific child flag of given class if there is any available among children.

Extract child flag of desired class.

Flag should be first created with createChild() method.

Returns:

>0 Pointer to child flag if there is any available. 0 Invalid pointer in case child flag does not exist.

Definition at line 277 of file FlagTxt.h.

References ClassID< T >::get(), and oMChildFlags_.

Referenced by operator<<().

                                   {
    // Get Class ID
    FlagID nID = ClassID<T>::get();

    // Find appropriate child
    std::pair<MChildFlags::const_iterator, MChildFlags::const_iterator>
      oFoundChildren = oMChildFlags_.equal_range( nID);

    // Return found child or invalid pointer in case child can not be found
    FlagTxt *poChild = 0;
    if( 1 == std::distance( oFoundChildren.first, oFoundChildren.second)) {
      // One child was found: copy pointer.
      // [ToDo: add support for several allowed children]
      poChild = oFoundChildren.first->second;
    }

    return poChild;
  }

template<class T>

int FlagTxt::getChildren

(

LChildren &

roLChildren

)

const [inline]

Search for children that are instances of the same class.

Extract child flags of desired class.

Flags should be first created with createChild() method. Method also can be used as a getChild but might be inconvenient since it adds std::list overhead

[CAUTION: Variable will be overwritten (!) Anything contained there will be removed]

Returns:

number of children available

Definition at line 301 of file FlagTxt.h.

References ClassID< T >::get(), and oMChildFlags_.

                                                        {
    // Get Class ID
    FlagID nID = ClassID<T>::get();

    // Find appropriate children
    std::pair<MChildFlags::const_iterator, MChildFlags::const_iterator>
      oFoundChildren = oMChildFlags_.equal_range( nID);

    // Return found child or invalid pointer in case child can not be found
    // Return list of found children or empty one if children can not be
    // found
    roLChildren.clear();
    if( 0 < std::distance( oFoundChildren.first, oFoundChildren.second)) {
      // A number of children was found: copy them into a list and return it
      while( oFoundChildren.first != oFoundChildren.second) {
        roLChildren.push_back( ( oFoundChildren.first++)->second);
      }
    } // End check if any children are found

    return roLChildren.size();
  }

virtual int FlagTxt::isChildValid

(

const FlagTxt *

)

const [inline, protected, virtual]

Specify policy of current flag: can it have any children? Should be overriden by successors.

Use:

dynamic_cast<const AllowedSubFlagClass *>( poCHILD_CANDIDATE)

expression to check if child is allowed.

Parameters:

poCHILD_CANDIDATE

Pointer to child candidate object that should be checked for validity.

Returns:

Number of allowed children: -1 No limit 0 No children allowed 1 One child only ... N N children allowed (current number of children may be from zero up to given number)

Reimplemented in DAQFlagTxt, DCSFlagTxt, DQMFlagTxt, and GlobalFlagTxt.

Definition at line 127 of file FlagTxt.h.

Referenced by createChild().

                                                                       {
        
      // No children are allowed by default
      return 0;
    }

template<class Archive>

void FlagTxt::load	(	Archive &	roArchive,
		const unsigned int &	rnVersion
	)			[inline, private]

Definition at line 350 of file FlagTxt.h.

References addChild(), Flag::eState_, and Flag::oComment_.

                                                                       {
    roArchive & eState_;
    roArchive & oComment_;

    // Read Child Flags: regular list will be extracted.
    LChildren oLChildren;
    roArchive & oLChildren;

    // Reconstruct map of child flags since IDs of classes are runtime
    // dependent.
    for( LChildren::const_iterator oIter = oLChildren.begin();
         oIter != oLChildren.end();
         ++oIter) {

      // Parent will be set by addChild(...)
      addChild( *oIter);
    }
  }

FlagTxt& FlagTxt::operator=

(

const FlagTxt &

roFLAGTXT

)

[private]

prevent copy assignment

Parameters:

roFLAGTXT

Flag to be copied

Returns:

Reference to current flag.

template<class Archive>

void FlagTxt::save	(	Archive &	roArchive,
		const unsigned int &	rnVersion
	)			const [inline, private]

--[ BEGIN ]-- Serialization section: Text format

Definition at line 330 of file FlagTxt.h.

References Flag::eState_, Flag::oComment_, and oMChildFlags_.

                                                                             {
    roArchive & eState_;
    roArchive & oComment_;

    // Copy Child Flags into list: we can not save map since IDs of classes
    // are runtime dependent. Solution: save pure list of child flags. And
    // Recreate map on reading the list from archive.
    LChildren oLChildren;
    for( MChildFlags::const_iterator oIter = oMChildFlags_.begin();
         oIter != oMChildFlags_.end();
         ++oIter) {

      oLChildren.push_back( oIter->second);
    }

    // Save Child Flags
    roArchive & oLChildren;
  }

bool FlagTxt::setState

(

const State &

reSTATE

)

[virtual]

Override base setState method to update parents state.

Parameters:

reSTATE

State of flag to be set.

Returns:

true In case flag's state was changed false Otherwise

Reimplemented from Flag.

Definition at line 20 of file FlagTxt.cc.

References poParentFlag_, Flag::setState(), and updateState().

Referenced by updateState().

                                            {
  bool bResult = Flag::setState( reSTATE);

  // Update parent value only in case child state modified and parent exists.
  if( bResult && poParentFlag_) {
    poParentFlag_->updateState( reSTATE);
  }

  return bResult;
}

void FlagTxt::updateState

(

const State &

reCHILD_STATE

)

[private]

Update parents state.

Given method specifies logic: how successors affect ancestors.

Parameters:

reCHILD_STATE

New state (changed) of Child flag

Definition at line 68 of file FlagTxt.cc.

References Flag::ERROR, Flag::eState_, Flag::OK, oMChildFlags_, setState(), and Flag::UNKNOWN.

Referenced by createChild(), and setState().

                                                     {
  switch( reCHILD_STATE) {
    case UNKNOWN:
      // Do nothing: Unknown state does not affect child nor parent
      break;
    case ERROR:
      // Child changed to ERROR state
      if( ERROR != eState_) {
        setState( ERROR);
      }
      break;
    case OK:
    {
      // Child changed to OK state
      State eNewState = OK;

      // Loop over children and check if all of them are OK now or UNKNOWN.
      for( MChildFlags::const_iterator oIter = oMChildFlags_.begin();
           oIter != oMChildFlags_.end();
           ++oIter) {

        if( ERROR == oIter->second->getState()) {
          eNewState = ERROR;

          // One ERROR child flag is enough for parent to be set into the same
          // state
          break;
        }
      } // End loop over children

      // So, did state change?
      if( eNewState != eState_) {
        setState( eNewState);
      }
      break;
    }
    default:
      // Unsupported State
      break;
  }
}

---

Friends And Related Function Documentation

friend class boost::serialization::access [friend]

--[ BEGIN ]-- Serialization section: Text format

Reimplemented in DAQFlagTxt, DCSFlagTxt, DQMFlagTxt, GlobalFlagTxt, TECFlagTxt, TIBFlagTxt, TIDFlagTxt, TOBFlagTxt, and TriggerFlagTxt.

Definition at line 176 of file FlagTxt.h.

friend class FlagXML [friend]

Grant access of FlagXML to children.

Used in conversion: Txt -> XML.

Definition at line 138 of file FlagTxt.h.

---

Member Data Documentation

MChildFlags FlagTxt::oMChildFlags_ [private]

Definition at line 191 of file FlagTxt.h.

Referenced by addChild(), FlagTxt(), FlagXML::FlagXML(), getChild(), getChildren(), save(), updateState(), and ~FlagTxt().

FlagTxt* FlagTxt::poParentFlag_ [private]

--[ END ]--

Definition at line 190 of file FlagTxt.h.

Referenced by addChild(), FlagTxt(), and setState().

---

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

• CalibTracker/SiStripRunSummary/interface/FlagTxt.h
• CalibTracker/SiStripRunSummary/src/FlagTxt.cc

---