NEOCCA bindings Specification  0.2.8
Public Member Functions
neo::cca::ports::ParameterPort Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for neo::cca::ports::ParameterPort:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~ParameterPort ()
virtual std::vector< std::string > readConfigurationKeys ()=0
 return the names of available parameter maps.
virtual neo::cca::TypeMap_shared readConfigurationMap ()=0 throw ( neo::cca::Exception )
 return a *copy* of the named map, for the caller to modify.
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.
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

Detailed Description

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


Constructor & Destructor Documentation

virtual neo::cca::ports::ParameterPort::~ParameterPort ( ) [inline, virtual]
{}

Member Function Documentation

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

return the names of available parameter maps.

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

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

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

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.

virtual std::string neo::cca::ports::ParameterPort::readTitle ( ) [pure virtual]
virtual std::vector< std::string > neo::cca::ports::ParameterPort::readGroupNames ( ) [pure virtual]
virtual std::string neo::cca::ports::ParameterPort::readGroupTitle ( const std::string &  groupName) [pure virtual]
virtual std::vector< std::string > neo::cca::ports::ParameterPort::readGroupKeys ( const std::string &  groupName) [pure virtual]
virtual std::string neo::cca::ports::ParameterPort::readHelp ( const std::string &  key) [pure virtual]
virtual std::string neo::cca::ports::ParameterPort::readPrompt ( const std::string &  key) [pure virtual]
virtual bool neo::cca::ports::ParameterPort::hasBounds ( const std::string &  key) [pure virtual]
virtual bool neo::cca::ports::ParameterPort::hasChoices ( const std::string &  key) [pure virtual]
virtual bool neo::cca::ports::ParameterPort::readDefaultBoolean ( const std::string &  key) [pure virtual]
virtual std::string neo::cca::ports::ParameterPort::readDefaultString ( const std::string &  key) [pure virtual]
virtual int32_t neo::cca::ports::ParameterPort::readDefaultInt ( const std::string &  key) [pure virtual]
virtual int64_t neo::cca::ports::ParameterPort::readDefaultLong ( const std::string &  key) [pure virtual]
virtual float neo::cca::ports::ParameterPort::readDefaultFloat ( const std::string &  key) [pure virtual]
virtual double neo::cca::ports::ParameterPort::readDefaultDouble ( const std::string &  key) [pure virtual]
virtual std::complex<float> neo::cca::ports::ParameterPort::readDefaultFcomplex ( const std::string &  key) [pure virtual]
virtual std::complex<double> neo::cca::ports::ParameterPort::readDefaultDcomplex ( const std::string &  key) [pure virtual]
virtual std::vector< std::string > neo::cca::ports::ParameterPort::readDefaultStringArray ( const std::string &  key) [pure virtual]
virtual std::vector< bool > neo::cca::ports::ParameterPort::readDefaultBooleanArray ( const std::string &  key) [pure virtual]
virtual std::vector< int32_t > neo::cca::ports::ParameterPort::readDefaultIntArray ( const std::string &  key) [pure virtual]
virtual std::vector< int64_t > neo::cca::ports::ParameterPort::readDefaultLongArray ( const std::string &  key) [pure virtual]
virtual std::vector< float > neo::cca::ports::ParameterPort::readDefaultFloatArray ( const std::string &  key) [pure virtual]
virtual std::vector< double > neo::cca::ports::ParameterPort::readDefaultDoubleArray ( const std::string &  key) [pure virtual]
virtual std::vector< std::complex<float> > neo::cca::ports::ParameterPort::readDefaultFcomplexArray ( const std::string &  key) [pure virtual]
virtual std::vector< std::complex<double> > neo::cca::ports::ParameterPort::readDefaultDcomplexArray ( const std::string &  key) [pure virtual]
virtual void neo::cca::ports::ParameterPort::readBoundsInt ( const std::string &  key,
int32_t &  low,
int32_t &  high 
) [pure virtual]
virtual void neo::cca::ports::ParameterPort::readBoundsLong ( const std::string &  key,
int64_t &  low,
int64_t &  high 
) [pure virtual]
virtual void neo::cca::ports::ParameterPort::readBoundsFloat ( const std::string &  key,
float &  low,
float &  high 
) [pure virtual]
virtual void neo::cca::ports::ParameterPort::readBoundsDouble ( const std::string &  key,
double &  low,
double &  high 
) [pure virtual]
virtual std::vector< std::string > neo::cca::ports::ParameterPort::readChoicesString ( const std::string &  key) [pure virtual]
virtual std::vector< int32_t > neo::cca::ports::ParameterPort::readChoicesInt ( const std::string &  key) [pure virtual]
virtual std::vector< int64_t > neo::cca::ports::ParameterPort::readChoicesLong ( const std::string &  key) [pure virtual]
virtual std::vector< float > neo::cca::ports::ParameterPort::readChoicesFloat ( const std::string &  key) [pure virtual]
virtual std::vector< double > neo::cca::ports::ParameterPort::readChoicesDouble ( const std::string &  key) [pure virtual]
virtual std::vector< std::complex<float> > neo::cca::ports::ParameterPort::readChoicesFcomplex ( const std::string &  key) [pure virtual]
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: