interface for querying adjustable parameters, their ranges, help strings, groupings for UI purposes, etc. More...

#include <ParameterPort.hh>

Inheritance diagram for neo::cca::ports::ParameterPort:

Collaboration diagram for neo::cca::ports::ParameterPort:

Public Member Functions
virtual	~ParameterPort ()

virtual std::vector< std::string >	readConfigurationKeys ()=0
	return the names of available parameter maps. More...

virtual neo::cca::TypeMap_shared	readConfigurationMap ()=0 throw ( neo::cca::Exception )
	return a copy of the named map, for the caller to modify. More...

virtual void	writeConfigurationMap (neo::cca::TypeMap_shared tm)=0 throw ( neo::cca::Exception )
	take values from the modifed map, tm, and copy them to the internal map of the given name. More...

virtual std::string	readTitle ()=0

virtual std::vector< std::string >	readGroupNames ()=0

virtual std::string	readGroupTitle (const std::string &groupName)=0

virtual std::vector< std::string >	readGroupKeys (const std::string &groupName)=0

virtual std::string	readHelp (const std::string &key)=0

virtual std::string	readPrompt (const std::string &key)=0

virtual bool	hasBounds (const std::string &key)=0

virtual bool	hasChoices (const std::string &key)=0

virtual bool	readDefaultBoolean (const std::string &key)=0

virtual std::string	readDefaultString (const std::string &key)=0

virtual int32_t	readDefaultInt (const std::string &key)=0

virtual int64_t	readDefaultLong (const std::string &key)=0

virtual float	readDefaultFloat (const std::string &key)=0

virtual double	readDefaultDouble (const std::string &key)=0

virtual std::complex< float >	readDefaultFcomplex (const std::string &key)=0

virtual std::complex< double >	readDefaultDcomplex (const std::string &key)=0

virtual std::vector< std::string >	readDefaultStringArray (const std::string &key)=0

virtual std::vector< bool >	readDefaultBooleanArray (const std::string &key)=0

virtual std::vector< int32_t >	readDefaultIntArray (const std::string &key)=0

virtual std::vector< int64_t >	readDefaultLongArray (const std::string &key)=0

virtual std::vector< float >	readDefaultFloatArray (const std::string &key)=0

virtual std::vector< double >	readDefaultDoubleArray (const std::string &key)=0

virtual std::vector< std::complex< float > >	readDefaultFcomplexArray (const std::string &key)=0

virtual std::vector< std::complex< double > >	readDefaultDcomplexArray (const std::string &key)=0

virtual void	readBoundsInt (const std::string &key, int32_t &low, int32_t &high)=0

virtual void	readBoundsLong (const std::string &key, int64_t &low, int64_t &high)=0

virtual void	readBoundsFloat (const std::string &key, float &low, float &high)=0

virtual void	readBoundsDouble (const std::string &key, double &low, double &high)=0

virtual std::vector< std::string >	readChoicesString (const std::string &key)=0

virtual std::vector< int32_t >	readChoicesInt (const std::string &key)=0

virtual std::vector< int64_t >	readChoicesLong (const std::string &key)=0

virtual std::vector< float >	readChoicesFloat (const std::string &key)=0

virtual std::vector< double >	readChoicesDouble (const std::string &key)=0

virtual std::vector< std::complex< float > >	readChoicesFcomplex (const std::string &key)=0

virtual std::vector< std::complex< double > >	readChoicesDcomplex (const std::string &key)=0

Public Member Functions inherited from neo::cca::ports::BasicParameterPort
virtual	~BasicParameterPort ()

Public Member Functions inherited from neo::cca::Port
virtual	~Port ()
	obligatory virtual destructor More...

Detailed Description

interface for querying adjustable parameters, their ranges, help strings, groupings for UI purposes, etc.

Constructor & Destructor Documentation

◆ ~ParameterPort()

virtual neo::cca::ports::ParameterPort::~ParameterPort ( )

inlinevirtual

17 {}

Member Function Documentation

◆ readConfigurationKeys()

virtual std::vector< std::string > neo::cca::ports::ParameterPort::readConfigurationKeys ( )

pure virtual

return the names of available parameter maps.

Implements neo::cca::ports::BasicParameterPort.

◆ readConfigurationMap()

virtual neo::cca::TypeMap_shared neo::cca::ports::ParameterPort::readConfigurationMap	(		)
throw	(	neo::cca::Exception
	)

pure virtual

return a copy of the named map, for the caller to modify.

Implements neo::cca::ports::BasicParameterPort.

◆ writeConfigurationMap()

virtual void neo::cca::ports::ParameterPort::writeConfigurationMap	(	neo::cca::TypeMap_shared	tm	)
throw	(	neo::cca::Exception
	)

pure virtual

take values from the modifed map, tm, and copy them to the internal map of the given name.

Implementers are free to ignore irrelevant data given in tm.

Implements neo::cca::ports::BasicParameterPort.

◆ readTitle()

virtual std::string neo::cca::ports::ParameterPort::readTitle ( )

pure virtual

◆ readGroupNames()

virtual std::vector< std::string > neo::cca::ports::ParameterPort::readGroupNames ( )

pure virtual

◆ readGroupTitle()

virtual std::string neo::cca::ports::ParameterPort::readGroupTitle ( const std::string & groupName )

pure virtual

◆ readGroupKeys()

virtual std::vector< std::string > neo::cca::ports::ParameterPort::readGroupKeys ( const std::string & groupName )

pure virtual

◆ readHelp()

virtual std::string neo::cca::ports::ParameterPort::readHelp ( const std::string & key )

pure virtual

◆ readPrompt()

virtual std::string neo::cca::ports::ParameterPort::readPrompt ( const std::string & key )

pure virtual

◆ hasBounds()

virtual bool neo::cca::ports::ParameterPort::hasBounds ( const std::string & key )

pure virtual

◆ hasChoices()

virtual bool neo::cca::ports::ParameterPort::hasChoices ( const std::string & key )

pure virtual

◆ readDefaultBoolean()

virtual bool neo::cca::ports::ParameterPort::readDefaultBoolean ( const std::string & key )

pure virtual

◆ readDefaultString()

virtual std::string neo::cca::ports::ParameterPort::readDefaultString ( const std::string & key )

pure virtual

◆ readDefaultInt()

virtual int32_t neo::cca::ports::ParameterPort::readDefaultInt ( const std::string & key )

pure virtual

◆ readDefaultLong()

virtual int64_t neo::cca::ports::ParameterPort::readDefaultLong ( const std::string & key )

pure virtual

◆ readDefaultFloat()

virtual float neo::cca::ports::ParameterPort::readDefaultFloat ( const std::string & key )

pure virtual

◆ readDefaultDouble()

virtual double neo::cca::ports::ParameterPort::readDefaultDouble ( const std::string & key )

pure virtual

◆ readDefaultFcomplex()

virtual std::complex<float> neo::cca::ports::ParameterPort::readDefaultFcomplex ( const std::string & key )

pure virtual

◆ readDefaultDcomplex()

virtual std::complex<double> neo::cca::ports::ParameterPort::readDefaultDcomplex ( const std::string & key )

pure virtual

◆ readDefaultStringArray()

virtual std::vector< std::string > neo::cca::ports::ParameterPort::readDefaultStringArray ( const std::string & key )

pure virtual

◆ readDefaultBooleanArray()

virtual std::vector< bool > neo::cca::ports::ParameterPort::readDefaultBooleanArray ( const std::string & key )

pure virtual

◆ readDefaultIntArray()

virtual std::vector< int32_t > neo::cca::ports::ParameterPort::readDefaultIntArray ( const std::string & key )

pure virtual

◆ readDefaultLongArray()

virtual std::vector< int64_t > neo::cca::ports::ParameterPort::readDefaultLongArray ( const std::string & key )

pure virtual

◆ readDefaultFloatArray()

virtual std::vector< float > neo::cca::ports::ParameterPort::readDefaultFloatArray ( const std::string & key )

pure virtual

◆ readDefaultDoubleArray()

virtual std::vector< double > neo::cca::ports::ParameterPort::readDefaultDoubleArray ( const std::string & key )

pure virtual

◆ readDefaultFcomplexArray()

virtual std::vector< std::complex<float> > neo::cca::ports::ParameterPort::readDefaultFcomplexArray ( const std::string & key )

pure virtual

◆ readDefaultDcomplexArray()

virtual std::vector< std::complex<double> > neo::cca::ports::ParameterPort::readDefaultDcomplexArray ( const std::string & key )

pure virtual

◆ readBoundsInt()

virtual void neo::cca::ports::ParameterPort::readBoundsInt	(	const std::string &	key,
		int32_t &	low,
		int32_t &	high
	)

pure virtual

◆ readBoundsLong()

virtual void neo::cca::ports::ParameterPort::readBoundsLong	(	const std::string &	key,
		int64_t &	low,
		int64_t &	high
	)

pure virtual

◆ readBoundsFloat()

virtual void neo::cca::ports::ParameterPort::readBoundsFloat	(	const std::string &	key,
		float &	low,
		float &	high
	)

pure virtual

◆ readBoundsDouble()

virtual void neo::cca::ports::ParameterPort::readBoundsDouble	(	const std::string &	key,
		double &	low,
		double &	high
	)

pure virtual

◆ readChoicesString()

virtual std::vector< std::string > neo::cca::ports::ParameterPort::readChoicesString ( const std::string & key )

pure virtual

◆ readChoicesInt()

virtual std::vector< int32_t > neo::cca::ports::ParameterPort::readChoicesInt ( const std::string & key )

pure virtual

◆ readChoicesLong()

virtual std::vector< int64_t > neo::cca::ports::ParameterPort::readChoicesLong ( const std::string & key )

pure virtual

◆ readChoicesFloat()

virtual std::vector< float > neo::cca::ports::ParameterPort::readChoicesFloat ( const std::string & key )

pure virtual

◆ readChoicesDouble()

virtual std::vector< double > neo::cca::ports::ParameterPort::readChoicesDouble ( const std::string & key )

pure virtual

◆ readChoicesFcomplex()

virtual std::vector< std::complex<float> > neo::cca::ports::ParameterPort::readChoicesFcomplex ( const std::string & key )

pure virtual

◆ readChoicesDcomplex()

virtual std::vector< std::complex<double> > neo::cca::ports::ParameterPort::readChoicesDcomplex ( const std::string & key )

pure virtual

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

ParameterPort.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~ParameterPort()

Member Function Documentation

◆ readConfigurationKeys()

◆ readConfigurationMap()

◆ writeConfigurationMap()

◆ readTitle()

◆ readGroupNames()

◆ readGroupTitle()

◆ readGroupKeys()

◆ readHelp()

◆ readPrompt()

◆ hasBounds()

◆ hasChoices()

◆ readDefaultBoolean()

◆ readDefaultString()

◆ readDefaultInt()

◆ readDefaultLong()

◆ readDefaultFloat()

◆ readDefaultDouble()

◆ readDefaultFcomplex()

◆ readDefaultDcomplex()

◆ readDefaultStringArray()

◆ readDefaultBooleanArray()

◆ readDefaultIntArray()

◆ readDefaultLongArray()

◆ readDefaultFloatArray()

◆ readDefaultDoubleArray()

◆ readDefaultFcomplexArray()

◆ readDefaultDcomplexArray()

◆ readBoundsInt()

◆ readBoundsLong()

◆ readBoundsFloat()

◆ readBoundsDouble()

◆ readChoicesString()

◆ readChoicesInt()

◆ readChoicesLong()

◆ readChoicesFloat()

◆ readChoicesDouble()

◆ readChoicesFcomplex()

◆ readChoicesDcomplex()