dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE > Class Template Reference

Concrete class to hold a segmentation parameter of a given type with its description. More...

#include <SegmentationParameter.h>

Inheritance diagram for dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >:

Public Member Functions
	TypedSegmentationParameter (const std::string &nam, const std::string &desc, TYPE &val, const TYPE &default_Value, SegmentationParameter::UnitType unitTyp=SegmentationParameter::NoUnit, bool isOpt=false)
	Default constructor. More...
virtual	~TypedSegmentationParameter ()
	Default destructor. More...
const TYPE &	typedValue () const
	Access to the parameter value. More...
void	setTypedValue (const TYPE &val)
	Set the parameter value. More...
const TYPE &	typedDefaultValue () const
	Access to the parameter default value. More...
std::string	type () const
	Access to the parameter type. More...
std::string	value () const
	Access to the parameter value in string representation. More...
void	setValue (const std::string &val)
	Set the parameter value in string representation. More...
std::string	defaultValue () const
	Access to the parameter default value in string representation. More...
Public Member Functions inherited from dd4hep::DDSegmentation::SegmentationParameter
virtual	~SegmentationParameter ()
	Default destructor. More...
const std::string &	name () const
	Access to the parameter name. More...
const std::string &	description () const
	Access to the parameter description. More...
UnitType	unitType () const
	Access to the unit type. More...
bool	isOptional () const
	Check if this parameter is optional. More...
std::string	toString () const
	Printable version. More...

Protected Attributes
TYPE *	_value = 0
TYPE	_defaultValue
Protected Attributes inherited from dd4hep::DDSegmentation::SegmentationParameter
std::string	_name
	The parameter name. More...
std::string	_description
	The parameter description. More...
UnitType	_unitType
	The unit type. More...
bool	_isOptional
	Store if parameter is optional. More...

Additional Inherited Members
Public Types inherited from dd4hep::DDSegmentation::SegmentationParameter
enum	UnitType { NoUnit, LengthUnit, AngleUnit }
	Defines the parameter unit type (useful to convert to default set of units) More...
Protected Member Functions inherited from dd4hep::DDSegmentation::SegmentationParameter
	SegmentationParameter (const std::string &nam, const std::string &desc, UnitType unitTyp=NoUnit, bool isOpt=false)
	Default constructor used by derived classes. More...

Detailed Description

template<typename TYPE>
class dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >

Concrete class to hold a segmentation parameter of a given type with its description.

Definition at line 166 of file SegmentationParameter.h.

Constructor & Destructor Documentation

TypedSegmentationParameter()

template<typename TYPE >

dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::TypedSegmentationParameter ( const std::string &  nam, const std::string &  desc, TYPE &  val, const TYPE &  default_Value, SegmentationParameter::UnitType  unitTyp = SegmentationParameter::NoUnit, bool  isOpt = false  )

inline

Default constructor.

Definition at line 174 of file SegmentationParameter.h.

~TypedSegmentationParameter()

template<typename TYPE >

virtual dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::~TypedSegmentationParameter ( )

inlinevirtual

Default destructor.

Definition at line 181 of file SegmentationParameter.h.

Member Function Documentation

defaultValue()

template<typename TYPE >

std::string dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::defaultValue ( ) const

inlinevirtual

Access to the parameter default value in string representation.

Implements dd4hep::DDSegmentation::SegmentationParameter.

Definition at line 218 of file SegmentationParameter.h.

setTypedValue()

template<typename TYPE >

void dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::setTypedValue ( const TYPE &  val )

inline

Set the parameter value.

Definition at line 189 of file SegmentationParameter.h.

setValue()

template<typename TYPE >

void dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::setValue ( const std::string &  val )

inlinevirtual

Set the parameter value in string representation.

Implements dd4hep::DDSegmentation::SegmentationParameter.

Definition at line 211 of file SegmentationParameter.h.

type()

template<typename TYPE >

std::string dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::type ( ) const

inlinevirtual

Access to the parameter type.

Implements dd4hep::DDSegmentation::SegmentationParameter.

Definition at line 199 of file SegmentationParameter.h.

typedDefaultValue()

template<typename TYPE >

const TYPE& dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::typedDefaultValue ( ) const

inline

Access to the parameter default value.

Definition at line 194 of file SegmentationParameter.h.

typedValue()

template<typename TYPE >

const TYPE& dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::typedValue ( ) const

inline

Access to the parameter value.

Definition at line 184 of file SegmentationParameter.h.

value()

template<typename TYPE >

std::string dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::value ( ) const

inlinevirtual

Access to the parameter value in string representation.

Implements dd4hep::DDSegmentation::SegmentationParameter.

Definition at line 204 of file SegmentationParameter.h.

Member Data Documentation

_defaultValue

template<typename TYPE >

TYPE dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::_defaultValue

protected

Definition at line 226 of file SegmentationParameter.h.

_value

template<typename TYPE >

TYPE* dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >::_value = 0

protected

Definition at line 225 of file SegmentationParameter.h.

---

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

• DDCore/include/DDSegmentation/SegmentationParameter.h