In This Package:

TabulatedProperty Class Reference

Class to define some (non-trivial) Property of materials and Surfaces. More...

#include <DetDesc/TabulatedProperty.h>

Inheritance diagram for TabulatedProperty:

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


Public Types
typedef std::pair< double, double >	Entry
typedef std::vector< Entry >	Table
	DEFAULT
	ALWAYS_VALID
	FORCE_UPDATE
enum	UpdateModeFlag { DEFAULT, ALWAYS_VALID, FORCE_UPDATE }
	Possible stata of the update flag. More...
Public Member Functions
	TabulatedProperty (const std::string &Name="")
	constructor
virtual	~TabulatedProperty ()
virtual const CLID &	clID () const
	Class ID of this instance.
virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII).
virtual MsgStream &	fillStream (MsgStream &s) const
	Fill the output stream (ASCII).
const std::string &	type () const
	acessors to property type
TabulatedProperty &	setType (const std::string &T)
const std::string &	xAxis () const
	acessors to name of x-axis
TabulatedProperty &	setXAxis (const std::string &T)
const std::string &	yAxis () const
	acessors to name of y-axis
TabulatedProperty &	setYAxis (const std::string &T)
Table &	table ()
	acessors to the table itself
const Table &	table () const
	operator Table & ()
	another form of accessors to table
	operator const Table & () const
template<class Func, class Iter>
const StatusCode	fill (Func func, Iter first, Iter last)
	Fill a table from the function.
virtual std::string	toXml (const std::string &name=std::string()) const
	Prepare an XML string representing the object.
virtual void	update (ValidDataObject &obj)
	Perform a deep copy (needed for usage in CondDB).
virtual StatusCode	update ()
	Update the current object and all the useds one (children, references, etc) only if needed, of course.
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 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
std::string	m_type
std::string	m_xAxis
std::string	m_yAxis
Table	m_table
Friends
friend std::ostream &	operator<< (std::ostream &s, const DataObject &obj)

Detailed Description

Class to define some (non-trivial) Property of materials and Surfaces.

Primary intended to describe optical properties of materials and surfaces (requests from RICH group). But since it is quite general it could be used for other similar stuff.

Author:: Vanya Belyaev

Date:: 26/02/2001

Author:: Marco Clemencic

Date:: 16/08/2005

Definition at line 28 of file TabulatedProperty.h.

Member Typedef Documentation

typedef std::pair<double,double> TabulatedProperty::Entry

Definition at line 33 of file TabulatedProperty.h.

typedef std::vector<Entry> TabulatedProperty::Table

Definition at line 34 of file TabulatedProperty.h.

Member Enumeration Documentation

enum ValidDataObject::UpdateModeFlag [inherited]

Possible stata of the update flag.

Enumerator:

DEFAULT
ALWAYS_VALID
FORCE_UPDATE

Definition at line 102 of file ValidDataObject.h.

00102                       {
00103     DEFAULT,
00104     ALWAYS_VALID,
00105     FORCE_UPDATE
00106   };

Constructor & Destructor Documentation

TabulatedProperty::TabulatedProperty ( const std::string & Name = "" )

constructor

virtual TabulatedProperty::~TabulatedProperty ( ) [virtual]

Member Function Documentation

virtual const CLID& TabulatedProperty::clID ( ) const [inline, virtual]

Class ID of this instance.

Reimplemented from ValidDataObject.

Definition at line 41 of file TabulatedProperty.h.

00041 { return TabulatedProperty::classID() ; }

static const CLID& TabulatedProperty::classID ( ) [inline, static]

Class ID of this class.

Reimplemented from ValidDataObject.

Definition at line 42 of file TabulatedProperty.h.

00042 { return CLID_TabulatedProperty       ; }

virtual std::ostream& TabulatedProperty::fillStream ( std::ostream & s ) const [virtual]

Fill the output stream (ASCII).

Reimplemented from ValidDataObject.

virtual MsgStream& TabulatedProperty::fillStream ( MsgStream & s ) const [virtual]

Fill the output stream (ASCII).

const std::string& TabulatedProperty::type ( ) const [inline]

acessors to property type

TabulatedProperty& TabulatedProperty::setType ( const std::string & T ) [inline]

const std::string& TabulatedProperty::xAxis ( ) const [inline]

acessors to name of x-axis

TabulatedProperty& TabulatedProperty::setXAxis ( const std::string & T ) [inline]

const std::string& TabulatedProperty::yAxis ( ) const [inline]

acessors to name of y-axis

TabulatedProperty& TabulatedProperty::setYAxis ( const std::string & T ) [inline]

Table& TabulatedProperty::table ( ) [inline]

acessors to the table itself

const Table& TabulatedProperty::table ( ) const [inline]

TabulatedProperty::operator Table & ( ) [inline]

another form of accessors to table

TabulatedProperty::operator const Table & ( ) const [inline]

template<class Func, class Iter>

const StatusCode TabulatedProperty::fill	(	Func	func,
		Iter	first,
		Iter	last
	)			`[inline]`

Fill a table from the function.

Parameters:

	func	The function. It could the the type of function, pointer to function, STL adaptor for member function, STL functional or any type of functor or function object
	first	"Iterator"(in STL sence) to a first element in a "sequence"
	last	"Iterator"(in STL sence) to a (last+1) element in a "sequence"

virtual std::string TabulatedProperty::toXml ( const std::string & name = std::string() ) const [virtual]

Prepare an XML string representing the object.

virtual void TabulatedProperty::update ( ValidDataObject & obj ) [virtual]

Perform a deep copy (needed for usage in CondDB).

A GaudiException is thrown if the object is not a TabulatedProperty.

Reimplemented from ValidDataObject.

virtual StatusCode ValidDataObject::update ( ) [virtual, inherited]

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 bool ValidDataObject::isValid ( ) const [virtual, inherited]

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

Implements IValidity.

virtual bool ValidDataObject::isValid ( const Gaudi::Time & t ) const [virtual, inherited]

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

Implements IValidity.

virtual const Gaudi::Time& ValidDataObject::validSince ( ) const [virtual, inherited]

Get start of validity.

Implements IValidity.

virtual const Gaudi::Time& ValidDataObject::validTill ( ) const [virtual, inherited]

Get end of validity.

Implements IValidity.

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

Set validity range.

Implements IValidity.

virtual void ValidDataObject::setValiditySince ( const Gaudi::Time & since ) [virtual, inherited]

Set start of validity.

Implements IValidity.

virtual void ValidDataObject::setValidityTill ( const Gaudi::Time & till ) [virtual, inherited]

Set end of validity.

Implements IValidity.

virtual const UpdateModeFlag& ValidDataObject::updateMode ( ) const [virtual, inherited]

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, inherited]

Set the mode for update.

virtual void ValidDataObject::defaultUpdateMode ( ) [virtual, inherited]

virtual void ValidDataObject::forceUpdateMode ( ) [virtual, inherited]

virtual void ValidDataObject::neverUpdateMode ( ) [virtual, inherited]

Member Data Documentation

std::string TabulatedProperty::m_type [private]

Definition at line 84 of file TabulatedProperty.h.

std::string TabulatedProperty::m_xAxis [private]

Definition at line 86 of file TabulatedProperty.h.

std::string TabulatedProperty::m_yAxis [private]

Definition at line 88 of file TabulatedProperty.h.

Table TabulatedProperty::m_table [private]

Definition at line 90 of file TabulatedProperty.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/TabulatedProperty.h

Generated on Mon Apr 11 20:00:22 2011 for DetDesc by 1.4.7

In This Package:

TabulatedProperty Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation