DtVariableParameterBuilder Class Reference

Base class that will allow for the addition of parameters that will be filled in with values from lua parameters. More...

Inheritance diagram for DtVariableParameterBuilder:

Public Member Functions
	DtVariableParameterBuilder ()
	CTOR.
virtual	~DtVariableParameterBuilder ()
	DTOR.
void	addVariableParameter (const std::string &, const DtVariableParameterInterface &)
void	removeVariableParameter (const std::string &)
template<typename _Container >
void	addVariableParameter (const std::string &s)
template<typename _Container >
void	addRequiredVariableParameter (const std::string &s)
template<typename _Container >
void	addVariableParameterVector (const std::string &s)
template<typename _Container >
void	addRequiredVariableParameterVector (const std::string &s)
template<typename _Container >
_Container	value (const std::string &key) const
template<typename _Container >
void	set (const std::string &key, const _Container &value)
virtual bool	valueIsSpecified (const std::string &) const
	Returns true if the parameter is defined and specified.
template<typename _Container >
std::vector< _Container >	valueToStdVector (const std::string &key) const
	Returns a std::vector<type> of table.
template<typename _Container >
std::set< _Container >	valueToStdSet (const std::string &key) const
virtual void	process (luabind::object const &parameters)
	Processes the arguments and fills in the variable parameters with values.

Protected Types
typedef std::map< std::string, DtVariableParameterInterface * >	VariableParameters

Protected Attributes
VariableParameters	myVariableParameters

Private Member Functions
	DtVariableParameterBuilder (const DtVariableParameterBuilder &orig)
	Not implemented.
DtVariableParameterBuilder &	operator= (const DtVariableParameterBuilder &orig)
	Not implemented.

Detailed Description

Base class that will allow for the addition of parameters that will be filled in with values from lua parameters.

Member Typedef Documentation

typedef std::map<std::string, DtVariableParameterInterface*> DtVariableParameterBuilder::VariableParameters

protected

Constructor & Destructor Documentation

DtVariableParameterBuilder::DtVariableParameterBuilder ( const DtVariableParameterBuilder &  orig )

private

Not implemented.

DtVariableParameterBuilder::DtVariableParameterBuilder

(

)

CTOR.

virtual DtVariableParameterBuilder::~DtVariableParameterBuilder ( )

virtual

DTOR.

Member Function Documentation

DtVariableParameterBuilder& DtVariableParameterBuilder::operator= ( const DtVariableParameterBuilder &  orig )

private

Not implemented.

void DtVariableParameterBuilder::addVariableParameter	(	const std::string &	,
		const DtVariableParameterInterface &
	)

void DtVariableParameterBuilder::removeVariableParameter

(

const std::string &

)

template<typename _Container >

void DtVariableParameterBuilder::addVariableParameter ( const std::string &  s )

inline

template<typename _Container >

void DtVariableParameterBuilder::addRequiredVariableParameter ( const std::string &  s )

inline

template<typename _Container >

void DtVariableParameterBuilder::addVariableParameterVector ( const std::string &  s )

inline

template<typename _Container >

void DtVariableParameterBuilder::addRequiredVariableParameterVector ( const std::string &  s )

inline

template<typename _Container >

_Container DtVariableParameterBuilder::value ( const std::string &  key ) const

inline

References DtVariableParameter< _Container >::value().

template<typename _Container >

void DtVariableParameterBuilder::set ( const std::string &  key, const _Container &  value  )

inline

virtual bool DtVariableParameterBuilder::valueIsSpecified ( const std::string &  ) const

virtual

Returns true if the parameter is defined and specified.

template<typename _Container >

std::vector<_Container> DtVariableParameterBuilder::valueToStdVector ( const std::string &  key ) const

inline

Returns a std::vector<type> of table.

template<typename _Container >

std::set<_Container> DtVariableParameterBuilder::valueToStdSet ( const std::string &  key ) const

inline

virtual void DtVariableParameterBuilder::process ( luabind::object const &  parameters )

virtual

Processes the arguments and fills in the variable parameters with values.

If any values are not specified and are required an exception will be thrown

Member Data Documentation

VariableParameters DtVariableParameterBuilder::myVariableParameters

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfLua/variableParameterBuilder.h