vistle::Parameter Class Reference

#include <core/parameter.h>

Inheritance diagram for vistle::Parameter:

Collaboration diagram for vistle::Parameter:

Public Member Functions
	DEFINE_ENUM_WITH_STRING_CONVERSIONS (Type,(Unknown)(Float)(Integer)(Vector)(IntVector)(String)(Invalid)) DEFINE_ENUM_WITH_STRING_CONVERSIONS(Presentation
	Generic (Filename)(ExistingFilename)(Directory)(ExistingDirectory)(NewPathname)(Boolean)(Choice)(Slider)(Color)(InvalidPresentation)) DEFINE_ENUM_WITH_STRING_CONVERSIONS(RangeType
Minimum()	Value (Maximum)) Parameter(int moduleId
	Parameter (const Parameter &other)
virtual	~Parameter ()
virtual Parameter *	clone () const =0
void	setPresentation (Presentation presentation)
void	setDescription (const std::string &description)
void	setChoices (const std::vector< std::string > &choices)
void	setGroup (const std::string &group)
const std::string &	group () const
virtual	operator std::string () const =0
virtual bool	isDefault () const =0
virtual bool	checkChoice (const std::vector< std::string > &choices) const
int	module () const
const std::string &	getName () const
Type	type () const
Presentation	presentation () const
const std::string &	description () const
const std::vector< std::string > &	choices () const

Public Attributes
Minimum() const std::string &	name
Minimum() const std::string	Type = Invalid
Minimum() const std::string	Presentation = Generic)

Protected Attributes
std::vector< std::string >	m_choices

Constructor & Destructor Documentation

Parameter()

vistle::Parameter::Parameter

(

const Parameter &

other

)

~Parameter()

vistle::Parameter::~Parameter ( )

virtual

Member Function Documentation

checkChoice()

virtual bool vistle::Parameter::checkChoice ( const std::vector< std::string > &  choices ) const

inlinevirtual

Reimplemented in vistle::ParameterBase< T >.

choices()

const std::vector< std::string > & vistle::Parameter::choices

(

)

const

clone()

virtual Parameter * vistle::Parameter::clone ( ) const

pure virtual

Implemented in vistle::ParameterBase< T >.

DEFINE_ENUM_WITH_STRING_CONVERSIONS()

vistle::Parameter::DEFINE_ENUM_WITH_STRING_CONVERSIONS	(	Type	,
		(Unknown)(Float)(Integer)(Vector)(IntVector)(String)(Invalid)
	)

description()

const std::string & vistle::Parameter::description

(

)

const

Generic()

vistle::Parameter::Generic

(

Filename

)

getName()

const std::string & vistle::Parameter::getName

(

)

const

group()

const std::string & vistle::Parameter::group

(

)

const

isDefault()

virtual bool vistle::Parameter::isDefault ( ) const

pure virtual

Implemented in vistle::ParameterBase< T >.

module()

int vistle::Parameter::module

(

)

const

operator std::string()

virtual vistle::Parameter::operator std::string ( ) const

pure virtual

Implemented in vistle::ParameterBase< T >.

presentation()

Parameter::Presentation vistle::Parameter::presentation

(

)

const

setChoices()

void vistle::Parameter::setChoices

(

const std::vector< std::string > &

choices

)

setDescription()

void vistle::Parameter::setDescription

(

const std::string &

description

)

setGroup()

void vistle::Parameter::setGroup

(

const std::string &

group

)

setPresentation()

void vistle::Parameter::setPresentation

(

Presentation

presentation

)

type()

Parameter::Type vistle::Parameter::type

(

)

const

Value()

Minimum() vistle::Parameter::Value

(

Maximum

)

Member Data Documentation

m_choices

std::vector<std::string> vistle::Parameter::m_choices

protected

name

Minimum() const std::string& vistle::Parameter::name

Presentation

Minimum() const std::string vistle::Parameter::Presentation = Generic)

Type

Minimum() const std::string vistle::Parameter::Type = Invalid

---

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

• core/parameter.h
• core/parameter.cpp