---

Flag Class Reference

Flag Base container that holds such values as: 1. More...

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

Inheritance diagram for Flag:

List of all members.

Public Types
enum	State { UNKNOWN = 0, ERROR = 1, OK = 2 }
	Available Flags states. More...
Public Member Functions
	Flag ()
std::string	getComment () const
	Retrieve Flags comment.
State	getState () const
	Retrieve Flags current state.
void	setComment (const std::string &roCOMMENT)
	Set flag comment.
virtual bool	setState (const State &reSTATE)
	Leave chance to override setState method to add option of updating parent value based on child change.
virtual	~Flag ()
Protected Member Functions
	Flag (const Flag &roFLAG)
	Allow only children to copy Flags.
Protected Attributes
State	eState_
	Unfortunately all properties of Flag (that are going to be serialized) have to be protected.
std::string	oComment_
Private Member Functions
Flag &	operator= (const Flag &rnFLAG)
	Prevent copying Flags via assignment.

---

Detailed Description

Flag Base container that holds such values as: 1.

Current Flag state 2. Flag comment

Definition at line 20 of file Flag.h.

---

Member Enumeration Documentation

enum Flag::State

Available Flags states.

Enumerator:

UNKNOWN
ERROR
OK

Definition at line 28 of file Flag.h.

               { UNKNOWN = 0, 
                 ERROR   = 1, 
                 OK      = 2 };

---

Constructor & Destructor Documentation

Flag::Flag

(

)

[inline]

Definition at line 32 of file Flag.h.

: eState_( UNKNOWN), oComment_( "") {}

virtual Flag::~Flag

(

)

[inline, virtual]

Definition at line 33 of file Flag.h.

{}

Flag::Flag

(

const Flag &

roFLAG

)

[inline, protected]

Allow only children to copy Flags.

Method is needed for base construction.

Parameters:

roFLAG

Flag to be copied.

Definition at line 87 of file Flag.h.

      : eState_  ( roFLAG.eState_),
        oComment_( roFLAG.oComment_) {}

---

Member Function Documentation

std::string Flag::getComment

(

)

const [inline]

Retrieve Flags comment.

Returns:

std::string Representing comment

Definition at line 77 of file Flag.h.

References oComment_.

Referenced by operator<<().

{ return oComment_; }

State Flag::getState

(

)

const [inline]

Retrieve Flags current state.

Returns:

Flag::State

Definition at line 68 of file Flag.h.

References eState_.

Referenced by FlagXML::createChild(), FlagTxt::createChild(), and operator<<().

{ return eState_; }

Flag& Flag::operator=

(

const Flag &

rnFLAG

)

[private]

Prevent copying Flags via assignment.

Parameters:

rnFLAG

Flag to be copied

Returns:

Reference to current flag

void Flag::setComment

(

const std::string &

roCOMMENT

)

[inline]

Set flag comment.

Parameters:

roCOMMENT

New comment to be set [any previous comment will be replaced]

Definition at line 57 of file Flag.h.

References oComment_.

Referenced by getTXTFlagTree(), getXMLFlagTree(), and setFlag().

                                                         {
      oComment_ = roCOMMENT;
    }

bool Flag::setState

(

const State &

reSTATE

)

[virtual]

Leave chance to override setState method to add option of updating parent value based on child change.

Should be implemented by children that hold containers of sub-flags.

Parameters:

reSTATE

New State of flag to be set

Returns:

true If flag state changed [it will change only in case new value differs from current one] false Otherwise

Reimplemented in FlagTxt, and FlagXML.

Definition at line 11 of file Flag.cc.

References eState_.

Referenced by setFlag(), FlagXML::setState(), and FlagTxt::setState().

                                         {
  // 1. reSTATE may be any value of: 0, 1, 2, 3...(2^n-1) where n is the nearest
  //    larger binary power.
  //
  //      oHackObj.setState( Flag::State( 3));
  //
  // 2. Change state of flag only in case a new value was submitted
  return ( 3 > static_cast<unsigned char>( reSTATE) &&
             reSTATE != eState_ ?
           ( eState_ = reSTATE, true) :
           false);
}

---

Member Data Documentation

State Flag::eState_ [protected]

Unfortunately all properties of Flag (that are going to be serialized) have to be protected.

Otherwise Serialization won't work :(.

Definition at line 96 of file Flag.h.

Referenced by getState(), FlagTxt::load(), FlagXML::load(), FlagTxt::save(), FlagXML::save(), setState(), FlagTxt::updateState(), and FlagXML::updateState().

std::string Flag::oComment_ [protected]

Definition at line 97 of file Flag.h.

Referenced by getComment(), FlagTxt::load(), FlagXML::load(), FlagTxt::save(), FlagXML::save(), and setComment().

---

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

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

---