marlin::ProcessorParameter Class Reference

Class that holds a steering variable for a marlin processor - automatically created by Processor::registerProcessorParameter() More...

#include <ProcessorParameter.h>

Inheritance diagram for marlin::ProcessorParameter:

Public Member Functions
	ProcessorParameter ()
virtual	~ProcessorParameter ()
virtual const std::string &	name ()
virtual const std::string &	description ()
virtual int	setSize ()
virtual bool	isOptional ()
virtual bool	valueSet ()
virtual const std::string	type ()=0
virtual const std::string	value ()=0
virtual const std::string	defaultValue ()=0
virtual void	setValue (StringParameters *params)=0

Protected Attributes
std::string	_description
std::string	_name
int	_setSize
bool	_optional
bool	_valueSet

Friends
std::ostream &	operator<< (std::ostream &, ProcessorParameter &)

Detailed Description

Class that holds a steering variable for a marlin processor - automatically created by Processor::registerProcessorParameter()

Author

F. Gaede, DESY

Version

Id:

ProcessorParameter.h,v 1.9 2006-08-03 15:16:34 gaede Exp

Definition at line 27 of file ProcessorParameter.h.

Constructor & Destructor Documentation

marlin::ProcessorParameter::ProcessorParameter ( )

inline

Definition at line 33 of file ProcessorParameter.h.

virtual marlin::ProcessorParameter::~ProcessorParameter ( )

inlinevirtual

Definition at line 37 of file ProcessorParameter.h.

Member Function Documentation

virtual const std::string marlin::ProcessorParameter::defaultValue ( )

pure virtual

Implemented in marlin::ProcessorParameter_t< T >.

Referenced by marlin::XMLFixCollTypes::parse(), marlin::Processor::printDescription(), and marlin::Processor::printDescriptionXML().

virtual const std::string& marlin::ProcessorParameter::description ( )

inlinevirtual

Definition at line 40 of file ProcessorParameter.h.

Referenced by marlin::CMProcessor::getParamD(), marlin::XMLFixCollTypes::parse(), marlin::Processor::printDescription(), and marlin::Processor::printDescriptionXML().

virtual bool marlin::ProcessorParameter::isOptional ( )

inlinevirtual

Definition at line 42 of file ProcessorParameter.h.

Referenced by marlin::CMProcessor::isParamOpt(), marlin::Processor::printDescription(), and marlin::Processor::printDescriptionXML().

virtual const std::string& marlin::ProcessorParameter::name ( )

inlinevirtual

Definition at line 39 of file ProcessorParameter.h.

Referenced by marlin::XMLFixCollTypes::parse(), marlin::Processor::printDescription(), and marlin::Processor::printDescriptionXML().

virtual int marlin::ProcessorParameter::setSize ( )

inlinevirtual

Definition at line 41 of file ProcessorParameter.h.

Referenced by marlin::CMProcessor::getParamSetSize().

virtual void marlin::ProcessorParameter::setValue ( StringParameters *  params )

pure virtual

Implemented in marlin::ProcessorParameter_t< T >.

virtual const std::string marlin::ProcessorParameter::type ( )

pure virtual

Implemented in marlin::ProcessorParameter_t< T >.

Referenced by marlin::CMProcessor::getParamT(), marlin::CMProcessor::isParamVec(), marlin::XMLFixCollTypes::parse(), marlin::Processor::printDescription(), marlin::Processor::printDescriptionXML(), and marlin::CCProcessor::writeToXML().

virtual const std::string marlin::ProcessorParameter::value ( )

pure virtual

Implemented in marlin::ProcessorParameter_t< T >.

virtual bool marlin::ProcessorParameter::valueSet ( )

inlinevirtual

Definition at line 43 of file ProcessorParameter.h.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  , ProcessorParameter &    )

friend

Member Data Documentation

std::string marlin::ProcessorParameter::_description

protected

Definition at line 55 of file ProcessorParameter.h.

std::string marlin::ProcessorParameter::_name

protected

Definition at line 56 of file ProcessorParameter.h.

bool marlin::ProcessorParameter::_optional

protected

Definition at line 58 of file ProcessorParameter.h.

int marlin::ProcessorParameter::_setSize

protected

Definition at line 57 of file ProcessorParameter.h.

bool marlin::ProcessorParameter::_valueSet

protected

Definition at line 59 of file ProcessorParameter.h.

---

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

• /afs/desy.de/user/d/dudarboh/iLCSoft/Marlin/source/include/marlin/ProcessorParameter.h