#include <ParameterPortFactory.hh>
Public Member Functions | |
virtual | ~ParameterPortFactory () |
virtual void | createParameterPort (neo::cca::TypeMap_shared portData, const ::std::string &portName)=0 |
Initialize the portData . | |
virtual void | setBatchTitle (neo::cca::TypeMap_shared portData, const ::std::string &title)=0 |
Define the window title for the parameter dialog. | |
virtual void | setGroupName (neo::cca::TypeMap_shared portData, const std::string &newGroupName)=0 |
Define the next tab/group title to use. | |
virtual void | setGroupNameAndTitle (neo::cca::TypeMap_shared portData, const std::string &newGroupName, const std::string &title)=0 |
virtual void | addRequestBoolean (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, bool deflt)=0 |
Define a boolean parameter and its default state. | |
virtual void | addRequestInt (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int deflt, int low, int high)=0 |
Define a int parameter and its default state. | |
virtual void | addRequestLong (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int64_t deflt, int64_t low, int64_t high)=0 |
Define a long parameter and its default state. | |
virtual void | addRequestFloat (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, float deflt, float low, float high)=0 |
Define a float parameter and its default state. | |
virtual void | addRequestDouble (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, double deflt, double low, double high)=0 |
Define a double parameter and its default state. | |
virtual void | addRequestString (neo::cca::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, const std::string &deflt)=0 |
Define a string parameter and its default state. | |
virtual void | addRequestStringChoice (neo::cca::TypeMap_shared portData, const std::string &key, const std::string &choice)=0 |
define a new choice for a string parameter. | |
virtual void | addStringChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::string > choices)=0 |
define more choices for a string parameter. | |
virtual void | addIntChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< int32_t > choices)=0 |
define more choices for a int32 parameter. | |
virtual void | addIntChoices (neo::cca::TypeMap_shared portData, const std::string &key, int32_t choices[], size_t nChoices)=0 |
define more choices for a int32 parameter, raw. | |
virtual void | addLongChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< int64_t > choices)=0 |
define more choices for a int64 parameter. | |
virtual void | addLongChoices (neo::cca::TypeMap_shared portData, const std::string &key, int64_t choices[], size_t nChoices)=0 |
define more choices for a int64 parameter, raw. | |
virtual void | addFloatChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< float > choices)=0 |
define more choices for a parameter. | |
virtual void | addFloatChoices (neo::cca::TypeMap_shared portData, const std::string &key, float choices[], size_t nChoices)=0 |
define more choices for a parameter, raw. | |
virtual void | addDoubleChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< double > choices)=0 |
define more choices for a parameter. | |
virtual void | addDoubleChoices (neo::cca::TypeMap_shared portData, const std::string &key, double choices[], size_t nChoices)=0 |
define more choices for a parameter, raw. | |
virtual void | addFcomplexChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::complex< float > > choices)=0 |
define more choices for a parameter. | |
virtual void | addFcomplexChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::complex< float > choices[], size_t nChoices)=0 |
define more choices for a parameter, raw. | |
virtual void | addDcomplexChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::vector< std::complex< double > > choices)=0 |
define more choices for a parameter. | |
virtual void | addDcomplexChoices (neo::cca::TypeMap_shared portData, const std::string &key, std::complex< double > choices[], size_t nChoices)=0 |
define more choices for a parameter, raw. | |
virtual void | clearRequests (neo::cca::TypeMap_shared portData)=0 |
Clear all previously added requests, titles, groups. | |
virtual void | registerUpdater (neo::cca::TypeMap_shared portData, ParameterGetListener *powner)=0 |
Register listener (the component) that wishes to have a chance to change the contents of its ParameterPort just before the parameters typemap is used to render the parameter dialog. | |
virtual void | registerUpdatedListener (neo::cca::TypeMap_shared portData, ParameterSetListener *powner)=0 |
Register listener (the component) if it wishes to be informed when an parameter is set. | |
virtual void | addParameterPort (neo::cca::TypeMap_shared portData, neo::cca::Services *svc)=0 |
Signal that the ParameterPort is fully defined and should now pop out on the component. | |
virtual void | removeParameterPort (neo::cca::TypeMap_shared portData, neo::cca::Services *svc)=0 |
Cause a previously defined parameter port to go away. |
virtual void neo::cca::ports::ParameterPortFactory::createParameterPort | ( | neo::cca::TypeMap_shared | portData, | |
const ::std::string & | portName | |||
) | [pure virtual] |
Initialize the portData .
..
virtual void neo::cca::ports::ParameterPortFactory::setBatchTitle | ( | neo::cca::TypeMap_shared | portData, | |
const ::std::string & | title | |||
) | [pure virtual] |
Define the window title for the parameter dialog.
virtual void neo::cca::ports::ParameterPortFactory::setGroupName | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | newGroupName | |||
) | [pure virtual] |
Define the next tab/group title to use.
All addRequest subsequent calls will add to this group. Multiple dialog tabs/groups can be defined in this way.
virtual void neo::cca::ports::ParameterPortFactory::setGroupNameAndTitle | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | newGroupName, | |||
const std::string & | title | |||
) | [pure virtual] |
virtual void neo::cca::ports::ParameterPortFactory::addRequestBoolean | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
bool | deflt | |||
) | [pure virtual] |
Define a boolean parameter and its default state.
virtual void neo::cca::ports::ParameterPortFactory::addRequestInt | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
int | deflt, | |||
int | low, | |||
int | high | |||
) | [pure virtual] |
Define a int parameter and its default state.
virtual void neo::cca::ports::ParameterPortFactory::addRequestLong | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
int64_t | deflt, | |||
int64_t | low, | |||
int64_t | high | |||
) | [pure virtual] |
Define a long parameter and its default state.
virtual void neo::cca::ports::ParameterPortFactory::addRequestFloat | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
float | deflt, | |||
float | low, | |||
float | high | |||
) | [pure virtual] |
Define a float parameter and its default state.
The configured value is always available by portData->getFloat(name, ...) and it will be in the range [low, high].
virtual void neo::cca::ports::ParameterPortFactory::addRequestDouble | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
double | deflt, | |||
double | low, | |||
double | high | |||
) | [pure virtual] |
Define a double parameter and its default state.
virtual void neo::cca::ports::ParameterPortFactory::addRequestString | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | name, | |||
const std::string & | help, | |||
const std::string & | prompt, | |||
const std::string & | deflt | |||
) | [pure virtual] |
Define a string parameter and its default state.
virtual void neo::cca::ports::ParameterPortFactory::addRequestStringChoice | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
const std::string & | choice | |||
) | [pure virtual] |
define a new choice for a string parameter.
virtual void neo::cca::ports::ParameterPortFactory::addStringChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< std::string > | choices | |||
) | [pure virtual] |
define more choices for a string parameter.
virtual void neo::cca::ports::ParameterPortFactory::addIntChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< int32_t > | choices | |||
) | [pure virtual] |
define more choices for a int32 parameter.
virtual void neo::cca::ports::ParameterPortFactory::addIntChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
int32_t | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a int32 parameter, raw.
nChoices is number of int elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::addLongChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< int64_t > | choices | |||
) | [pure virtual] |
define more choices for a int64 parameter.
virtual void neo::cca::ports::ParameterPortFactory::addLongChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
int64_t | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a int64 parameter, raw.
nChoices is number of long elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::addFloatChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< float > | choices | |||
) | [pure virtual] |
define more choices for a parameter.
virtual void neo::cca::ports::ParameterPortFactory::addFloatChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
float | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a parameter, raw.
nChoices is number of long elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::addDoubleChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< double > | choices | |||
) | [pure virtual] |
define more choices for a parameter.
virtual void neo::cca::ports::ParameterPortFactory::addDoubleChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
double | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a parameter, raw.
nChoices is number of long elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::addFcomplexChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< std::complex< float > > | choices | |||
) | [pure virtual] |
define more choices for a parameter.
virtual void neo::cca::ports::ParameterPortFactory::addFcomplexChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::complex< float > | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a parameter, raw.
nChoices is number of long elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::addDcomplexChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::vector< std::complex< double > > | choices | |||
) | [pure virtual] |
define more choices for a parameter.
virtual void neo::cca::ports::ParameterPortFactory::addDcomplexChoices | ( | neo::cca::TypeMap_shared | portData, | |
const std::string & | key, | |||
std::complex< double > | choices[], | |||
size_t | nChoices | |||
) | [pure virtual] |
define more choices for a parameter, raw.
nChoices is number of long elements in choices, not memory size.
virtual void neo::cca::ports::ParameterPortFactory::clearRequests | ( | neo::cca::TypeMap_shared | portData | ) | [pure virtual] |
Clear all previously added requests, titles, groups.
After this call, it is as if the ParameterPort has been created but never configured. The values of previously defined parameters will, nonethesless, remain in the typemap. (They may have been in the map before it was used as a parameter port, after all.) Typically, this is used only by someone implementing the updateParameterPort function from class ParameterGetListener.
virtual void neo::cca::ports::ParameterPortFactory::registerUpdater | ( | neo::cca::TypeMap_shared | portData, | |
ParameterGetListener * | powner | |||
) | [pure virtual] |
Register listener (the component) that wishes to have a chance to change the contents of its ParameterPort just before the parameters typemap is used to render the parameter dialog.
powner | a pointer to the listener that will be forgotten when it is no longer needed. | |
portData | the component's private parameter data map. |
virtual void neo::cca::ports::ParameterPortFactory::registerUpdatedListener | ( | neo::cca::TypeMap_shared | portData, | |
ParameterSetListener * | powner | |||
) | [pure virtual] |
Register listener (the component) if it wishes to be informed when an parameter is set.
Listeners are called after values are set.
powner | a pointer to the listener that will be forgotten when it is no longer needed. | |
portData | the component's private parameter data map. |
virtual void neo::cca::ports::ParameterPortFactory::addParameterPort | ( | neo::cca::TypeMap_shared | portData, | |
neo::cca::Services * | svc | |||
) | [pure virtual] |
Signal that the ParameterPort is fully defined and should now pop out on the component.
The Services passed here must be the component's own Services handle.
virtual void neo::cca::ports::ParameterPortFactory::removeParameterPort | ( | neo::cca::TypeMap_shared | portData, | |
neo::cca::Services * | svc | |||
) | [pure virtual] |
Cause a previously defined parameter port to go away.