In This Package:

ValidDataObject Class Reference

A simple DataObject implementing the IValidity interface. More...

#include <DetDesc/ValidDataObject.h>

Inheritance diagram for ValidDataObject:

[legend]Collaboration diagram for ValidDataObject:[legend]List of all members.

Public Types
	DEFAULT
	ALWAYS_VALID
	FORCE_UPDATE
enum	UpdateModeFlag { DEFAULT, ALWAYS_VALID, FORCE_UPDATE }
	Possible stata of the update flag. More...
Public Member Functions
	ValidDataObject ()
	Default constructor.
	ValidDataObject (const ValidDataObject &obj)
	Copy constructor.
virtual void	update (ValidDataObject &obj)
	Update using another instance of this class: deep copy all contents, except for the properties of a generic DataObject.
virtual	~ValidDataObject ()
	Destructor.
virtual const CLID &	clID () const
	Class ID of this instance.
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII).
virtual bool	isValid () const
	Check if the data object has a well defined validity range.
virtual bool	isValid (const Gaudi::Time &t) const
	Check if the data object is valid at the specified time.
virtual const Gaudi::Time &	validSince () const
	Get start of validity.
virtual const Gaudi::Time &	validTill () const
	Get end of validity.
virtual void	setValidity (const Gaudi::Time &since, const Gaudi::Time &till)
	Set validity range.
virtual void	setValiditySince (const Gaudi::Time &since)
	Set start of validity.
virtual void	setValidityTill (const Gaudi::Time &till)
	Set end of validity.
virtual StatusCode	update ()
	Update the current object and all the useds one (children, references, etc) only if needed, of course.
virtual const UpdateModeFlag &	updateMode () const
	Return the update mode: ValidDataObject::DEFAULT -> use the actual validity ValidDataObject::ALWAYS_VALID -> never update ValidDataObject::FORCE_UPDATE -> force an update even if still valid (then back to DEFAULT behaviour).
virtual void	setUpdateMode (UpdateModeFlag mode)
	Set the mode for update.
virtual void	defaultUpdateMode ()
virtual void	forceUpdateMode ()
virtual void	neverUpdateMode ()
void	setRegistry (IRegistry *pRegistry)
IRegistry *	registry () const
LinkManager *	linkMgr () const
unsigned char	version () const
void	setVersion (unsigned char vsn)
unsigned long	refCount () const
virtual unsigned long	addRef ()
virtual unsigned long	release ()
const std::string &	name () const
virtual StreamBuffer &	serialize (StreamBuffer &s)
virtual StreamBuffer &	serialize (StreamBuffer &s) const
Static Public Member Functions
static const CLID &	classID ()
	Class ID of this class.
Private Attributes
Gaudi::Time	m_validSince
	Start of validity.
Gaudi::Time	m_validUntil
	End of validity.
UpdateModeFlag	m_updateMode
	Flag to force/inhibit the update regardless of the validity.
Friends
friend std::ostream &	operator<< (std::ostream &s, const DataObject &obj)

---

Detailed Description

A simple DataObject implementing the IValidity interface.

Author:

Andrea Valassi

Date:

February 2001

Author:

Marco Clemencic

Date:

February 2005

Definition at line 29 of file ValidDataObject.h.

---

Member Enumeration Documentation

enum ValidDataObject::UpdateModeFlag

Possible stata of the update flag.

Enumerator:

DEFAULT
ALWAYS_VALID
FORCE_UPDATE

Definition at line 102 of file ValidDataObject.h.

                      {
    DEFAULT,
    ALWAYS_VALID,
    FORCE_UPDATE
  };

---

Constructor & Destructor Documentation

ValidDataObject::ValidDataObject

(

)

Default constructor.

ValidDataObject::ValidDataObject

(

const ValidDataObject &

obj

)

Copy constructor.

virtual ValidDataObject::~ValidDataObject

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void ValidDataObject::update

(

ValidDataObject &

obj

)

[virtual]

Update using another instance of this class: deep copy all contents, except for the properties of a generic DataObject.

Reimplemented in Condition, ParamValidDataObject, and TabulatedProperty.

virtual const CLID& ValidDataObject::clID

(

)

const [inline, virtual]

Class ID of this instance.

Reimplemented from DataObject.

Reimplemented in AlignmentCondition, Condition, DetectorElement, LAssembly, LVolume, and TabulatedProperty.

Definition at line 59 of file ValidDataObject.h.

{ return classID(); } 

static const CLID& ValidDataObject::classID

(

)

[inline, static]

Class ID of this class.

Reimplemented from DataObject.

Reimplemented in AlignmentCondition, Condition, DetectorElement, LAssembly, LVolume, and TabulatedProperty.

Definition at line 62 of file ValidDataObject.h.

{ return CLID_ValidDataObject; }

virtual std::ostream& ValidDataObject::fillStream

(

std::ostream &

s

)

const [virtual]

Fill the output stream (ASCII).

Reimplemented from DataObject.

Reimplemented in AlignmentCondition, ParamValidDataObject, and TabulatedProperty.

virtual bool ValidDataObject::isValid

(

)

const [virtual]

Check if the data object has a well defined validity range.

Implements IValidity.

virtual bool ValidDataObject::isValid

(

const Gaudi::Time &

t

)

const [virtual]

Check if the data object is valid at the specified time.

Implements IValidity.

virtual const Gaudi::Time& ValidDataObject::validSince

(

)

const [virtual]

Get start of validity.

Implements IValidity.

virtual const Gaudi::Time& ValidDataObject::validTill

(

)

const [virtual]

Get end of validity.

Implements IValidity.

virtual void ValidDataObject::setValidity	(	const Gaudi::Time &	since,
		const Gaudi::Time &	till
	)			[virtual]

Set validity range.

Implements IValidity.

virtual void ValidDataObject::setValiditySince

(

const Gaudi::Time &

since

)

[virtual]

Set start of validity.

Implements IValidity.

virtual void ValidDataObject::setValidityTill

(

const Gaudi::Time &

till

)

[virtual]

Set end of validity.

Implements IValidity.

virtual StatusCode ValidDataObject::update

(

)

[virtual]

Update the current object and all the useds one (children, references, etc) only if needed, of course.

This method must be reimplemented for more complex objects.

virtual const UpdateModeFlag& ValidDataObject::updateMode

(

)

const [virtual]

Return the update mode: ValidDataObject::DEFAULT -> use the actual validity
ValidDataObject::ALWAYS_VALID -> never update ValidDataObject::FORCE_UPDATE -> force an update even if still valid (then back to DEFAULT behaviour).

virtual void ValidDataObject::setUpdateMode

(

UpdateModeFlag

mode

)

[virtual]

Set the mode for update.

virtual void ValidDataObject::defaultUpdateMode

(

)

[virtual]

virtual void ValidDataObject::forceUpdateMode

(

)

[virtual]

virtual void ValidDataObject::neverUpdateMode

(

)

[virtual]

---

Member Data Documentation

Gaudi::Time ValidDataObject::m_validSince [private]

Start of validity.

Definition at line 128 of file ValidDataObject.h.

Gaudi::Time ValidDataObject::m_validUntil [private]

End of validity.

Definition at line 130 of file ValidDataObject.h.

UpdateModeFlag ValidDataObject::m_updateMode [private]

Flag to force/inhibit the update regardless of the validity.

Definition at line 133 of file ValidDataObject.h.

---

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

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDesc/DetDesc/ValidDataObject.h

---