dd4hep::DDSegmentation::SegmentationParameter Class Reference

Class to hold a segmentation parameter with its description. More...

#include <SegmentationParameter.h>

Inheritance diagram for dd4hep::DDSegmentation::SegmentationParameter:

Public Types
enum	UnitType { NoUnit, LengthUnit, AngleUnit }
	Defines the parameter unit type (useful to convert to default set of units) More...

Public Member Functions
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...
virtual std::string	type () const =0
	Access to the parameter type. More...
virtual std::string	value () const =0
	Access to the parameter value in string representation. More...
virtual void	setValue (const std::string &value)=0
	Set the parameter value in string representation. More...
virtual std::string	defaultValue () const =0
	Access to the parameter default value in string representation. More...
bool	isOptional () const
	Check if this parameter is optional. More...
std::string	toString () const
	Printable version. More...

Protected Member Functions
	SegmentationParameter (const std::string &nam, const std::string &desc, UnitType unitTyp=NoUnit, bool isOpt=false)
	Default constructor used by derived classes. More...

Protected Attributes
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...

Detailed Description

Class to hold a segmentation parameter with its description.

Definition at line 107 of file SegmentationParameter.h.

Member Enumeration Documentation

UnitType

enum dd4hep::DDSegmentation::SegmentationParameter::UnitType

Defines the parameter unit type (useful to convert to default set of units)

Enumerator
NoUnit
LengthUnit
AngleUnit

Definition at line 110 of file SegmentationParameter.h.

Constructor & Destructor Documentation

~SegmentationParameter()

virtual dd4hep::DDSegmentation::SegmentationParameter::~SegmentationParameter ( )

inlinevirtual

Default destructor.

Definition at line 114 of file SegmentationParameter.h.

SegmentationParameter()

dd4hep::DDSegmentation::SegmentationParameter::SegmentationParameter ( const std::string &  nam, const std::string &  desc, UnitType  unitTyp = NoUnit, bool  isOpt = false  )

inlineprotected

Default constructor used by derived classes.

Definition at line 151 of file SegmentationParameter.h.

Member Function Documentation

defaultValue()

virtual std::string dd4hep::DDSegmentation::SegmentationParameter::defaultValue ( ) const

pure virtual

Access to the parameter default value in string representation.

Implemented in dd4hep::DDSegmentation::TypedSegmentationParameter< std::vector< TYPE > >, and dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >.

description()

const std::string& dd4hep::DDSegmentation::SegmentationParameter::description ( ) const

inline

Access to the parameter description.

Definition at line 121 of file SegmentationParameter.h.

isOptional()

bool dd4hep::DDSegmentation::SegmentationParameter::isOptional ( ) const

inline

Check if this parameter is optional.

Definition at line 137 of file SegmentationParameter.h.

name()

const std::string& dd4hep::DDSegmentation::SegmentationParameter::name ( ) const

inline

Access to the parameter name.

Definition at line 117 of file SegmentationParameter.h.

setValue()

virtual void dd4hep::DDSegmentation::SegmentationParameter::setValue ( const std::string &  value )

pure virtual

Set the parameter value in string representation.

Implemented in dd4hep::DDSegmentation::TypedSegmentationParameter< std::vector< TYPE > >, and dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >.

toString()

std::string dd4hep::DDSegmentation::SegmentationParameter::toString ( ) const

inline

Printable version.

Definition at line 141 of file SegmentationParameter.h.

type()

virtual std::string dd4hep::DDSegmentation::SegmentationParameter::type ( ) const

pure virtual

Access to the parameter type.

Implemented in dd4hep::DDSegmentation::TypedSegmentationParameter< std::vector< TYPE > >, and dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >.

unitType()

UnitType dd4hep::DDSegmentation::SegmentationParameter::unitType ( ) const

inline

Access to the unit type.

Definition at line 125 of file SegmentationParameter.h.

value()

virtual std::string dd4hep::DDSegmentation::SegmentationParameter::value ( ) const

pure virtual

Access to the parameter value in string representation.

Implemented in dd4hep::DDSegmentation::TypedSegmentationParameter< std::vector< TYPE > >, and dd4hep::DDSegmentation::TypedSegmentationParameter< TYPE >.

Member Data Documentation

_description

std::string dd4hep::DDSegmentation::SegmentationParameter::_description

protected

The parameter description.

Definition at line 158 of file SegmentationParameter.h.

_isOptional

bool dd4hep::DDSegmentation::SegmentationParameter::_isOptional

protected

Store if parameter is optional.

Definition at line 162 of file SegmentationParameter.h.

_name

std::string dd4hep::DDSegmentation::SegmentationParameter::_name

protected

The parameter name.

Definition at line 156 of file SegmentationParameter.h.

_unitType

UnitType dd4hep::DDSegmentation::SegmentationParameter::_unitType

protected

The unit type.

Definition at line 160 of file SegmentationParameter.h.

---

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

• DDCore/include/DDSegmentation/SegmentationParameter.h