CCAFFEINE  0.8.8
Public Member Functions | Private Attributes
OpqParameterPortFactory Class Reference
Inheritance diagram for OpqParameterPortFactory:
Inheritance graph
[legend]
Collaboration diagram for OpqParameterPortFactory:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OpqParameterPortFactory (int bogon)
virtual void createParameterPort (::ccafeopq::TypeMap_shared portData, const ::std::string &portName)
virtual void setBatchTitle (::ccafeopq::TypeMap_shared portData, const ::std::string &title)
virtual void setGroupName (::ccafeopq::TypeMap_shared portData, const std::string &newGroupName)
virtual void addRequestBoolean (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, bool deflt)
virtual void addRequestInt (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int deflt, int low, int high)
virtual void addRequestLong (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, int64_t deflt, int64_t low, int64_t high)
virtual void addRequestFloat (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, float deflt, float low, float high)
virtual void addRequestDouble (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, double deflt, double low, double high)
virtual void addRequestString (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &help, const std::string &prompt, const std::string &deflt)
virtual void addRequestStringChoice (::ccafeopq::TypeMap_shared portData, const std::string &name, const std::string &choice)
virtual void clearRequests (::ccafeopq::TypeMap_shared portData)
virtual void setUpdater (::ccafeopq::TypeMap_shared portData,::ccafeopq::ports::ParameterGetListener_shared powner)
virtual void setUpdatedListener (::ccafeopq::TypeMap_shared portData,::ccafeopq::ports::ParameterSetListener_shared powner)
virtual void publishParameterPort (::ccafeopq::TypeMap_shared portData,::ccafeopq::Services *svc)
virtual void unpublishParameterPort (::ccafeopq::TypeMap_shared portData,::ccafeopq::Services *svc)
virtual void setGroupNameAndTitle (ccafeopq::TypeMap_shared, const std::string &groupName, const std::string &title)
virtual void registerUpdater (ccafeopq::TypeMap_shared tm, ccafeopq::ports::ParameterGetListener_shared pgl)
virtual void registerUpdatedListener (ccafeopq::TypeMap_shared tm, ccafeopq::ports::ParameterSetListener_shared psl)
virtual void addParameterPort (ccafeopq::TypeMap_shared tm, ccafeopq::Services *svc)
virtual void removeParameterPort (ccafeopq::TypeMap_shared tm, ccafeopq::Services *svc)
virtual void addStringChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< std::string > choices)
virtual void addIntChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< int32_t > choices)
virtual void addIntChoices (ccafeopq::TypeMap_shared portData, const std::string &key, int32_t choices[], size_t nChoices)
virtual void addLongChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< int64_t > choices)
virtual void addLongChoices (ccafeopq::TypeMap_shared portData, const std::string &key, int64_t choices[], size_t nChoices)
virtual void addFloatChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< float > choices)
virtual void addFloatChoices (ccafeopq::TypeMap_shared portData, const std::string &key, float choices[], size_t nChoices)
virtual void addDoubleChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< double > choices)
virtual void addDoubleChoices (ccafeopq::TypeMap_shared portData, const std::string &key, double choices[], size_t nChoices)
virtual void addFcomplexChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< std::complex< float > > choices)
virtual void addFcomplexChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::complex< float > choices[], size_t nChoices)
virtual void addDcomplexChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::vector< std::complex< double > > choices)
virtual void addDcomplexChoices (ccafeopq::TypeMap_shared portData, const std::string &key, std::complex< double > choices[], size_t nChoices)

Private Attributes

std::map< std::string, void * > delegates

Member Function Documentation

virtual void OpqParameterPortFactory::createParameterPort ( ::ccafeopq::TypeMap_shared  portData,
const ::std::string &  portName 
) [virtual]

Initialize the portData for use as a parameter dialog port with name portName. More than one such port can be defined. Each must be published before the next can be created. The given string portName will appear in the ::ccafeopq::TypeMap_shared as the result of this function and must not be changed by the component henceforth.

Parameters:
portDatathe typemap associated with the port; It is shared between the ParameterPortFactory and the component. The ParameterPortFacotry will not read or change values in portData except those requested via the addRequest functions.
portNameThe name of a ParameterPort to appear in user interface one way or another.
virtual void OpqParameterPortFactory::setBatchTitle ( ::ccafeopq::TypeMap_shared  portData,
const ::std::string &  title 
) [virtual]

Define the window title for the parameter dialog.

virtual void OpqParameterPortFactory::setGroupName ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  newGroupName 
) [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 OpqParameterPortFactory::addRequestBoolean ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
bool  deflt 
) [virtual]

Define a boolean parameter and its default state. The configured value is always available by portData->getBool(name, ...);

virtual void OpqParameterPortFactory::addRequestInt ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
int  deflt,
int  low,
int  high 
) [virtual]

Define a int parameter and its default state. The configured value is always available by portData->getInt(name, ...) and it will be in the range [low, high].

virtual void OpqParameterPortFactory::addRequestLong ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
int64_t  deflt,
int64_t  low,
int64_t  high 
) [virtual]

Define a long parameter and its default state. The configured value is always available by portData->getLong(name, ...) and it will be in the range [low, high].

virtual void OpqParameterPortFactory::addRequestFloat ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
float  deflt,
float  low,
float  high 
) [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 OpqParameterPortFactory::addRequestDouble ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
double  deflt,
double  low,
double  high 
) [virtual]

Define a double parameter and its default state. The configured value is always available by portData->getDouble(name, ...) and it will be in the range [low, high].

virtual void OpqParameterPortFactory::addRequestString ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  help,
const std::string &  prompt,
const std::string &  deflt 
) [virtual]

Define a string parameter and its default state. The configured value is always available by portData->getString(name, ...). If no addRequestStringChoice calls are made, the user input may be any string. If addRequestStringChoice is used, the value will be one among the choices. If addRequestStringChoice is used, deflt must be among the choices defined.

virtual void OpqParameterPortFactory::addRequestStringChoice ( ::ccafeopq::TypeMap_shared  portData,
const std::string &  name,
const std::string &  choice 
) [virtual]

define a new choice for a string parameter.

virtual void OpqParameterPortFactory::clearRequests ( ::ccafeopq::TypeMap_shared  portData) [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. Typically, this is used only by someone implementing the updateParameterPort function from class ::ccafeopq::ports::ParameterGetListener {

virtual void OpqParameterPortFactory::setUpdater ( ::ccafeopq::TypeMap_shared  portData,
::ccafeopq::ports::ParameterGetListener_shared  powner 
) [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.

Parameters:
pownera pointer to the listener that will be forgotten when it is no longer needed.
virtual void OpqParameterPortFactory::setUpdatedListener ( ::ccafeopq::TypeMap_shared  portData,
::ccafeopq::ports::ParameterSetListener_shared  powner 
) [virtual]

Register listener (the component) if it wishes to be informed when an parameter is set. Listeners are called after values are set.

virtual void OpqParameterPortFactory::publishParameterPort ( ::ccafeopq::TypeMap_shared  portData,
::ccafeopq::Services *  svc 
) [virtual]

Signal that the ParameterPort is fully defined and should now pop out on the component. The ::ccafeopq::Services passed here must be the component's own ::ccafeopq::Services handle.

virtual void OpqParameterPortFactory::unpublishParameterPort ( ::ccafeopq::TypeMap_shared  portData,
::ccafeopq::Services *  svc 
) [virtual]

Cause a previously defined parameter port to go away.

virtual void OpqParameterPortFactory::addStringChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< std::string >  choices 
) [virtual]

define more choices for a string parameter.

virtual void OpqParameterPortFactory::addIntChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< int32_t >  choices 
) [virtual]

define more choices for a int32 parameter.

virtual void OpqParameterPortFactory::addIntChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
int32_t  choices[],
size_t  nChoices 
) [virtual]

define more choices for a int32 parameter, raw. nChoices is number of int elements in choices, not memory size.

virtual void OpqParameterPortFactory::addLongChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< int64_t >  choices 
) [virtual]

define more choices for a int64 parameter.

virtual void OpqParameterPortFactory::addLongChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
int64_t  choices[],
size_t  nChoices 
) [virtual]

define more choices for a int64 parameter, raw. nChoices is number of long elements in choices, not memory size.

virtual void OpqParameterPortFactory::addFloatChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< float >  choices 
) [virtual]

define more choices for a parameter.

virtual void OpqParameterPortFactory::addFloatChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
float  choices[],
size_t  nChoices 
) [virtual]

define more choices for a parameter, raw. nChoices is number of long elements in choices, not memory size.

virtual void OpqParameterPortFactory::addDoubleChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< double >  choices 
) [virtual]

define more choices for a parameter.

virtual void OpqParameterPortFactory::addDoubleChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
double  choices[],
size_t  nChoices 
) [virtual]

define more choices for a parameter, raw. nChoices is number of long elements in choices, not memory size.

virtual void OpqParameterPortFactory::addFcomplexChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< std::complex< float > >  choices 
) [virtual]

define more choices for a parameter.

virtual void OpqParameterPortFactory::addFcomplexChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::complex< float >  choices[],
size_t  nChoices 
) [virtual]

define more choices for a parameter, raw. nChoices is number of long elements in choices, not memory size.

virtual void OpqParameterPortFactory::addDcomplexChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::vector< std::complex< double > >  choices 
) [virtual]

define more choices for a parameter.

virtual void OpqParameterPortFactory::addDcomplexChoices ( ccafeopq::TypeMap_shared  portData,
const std::string &  key,
std::complex< double >  choices[],
size_t  nChoices 
) [virtual]

define more choices for a parameter, raw. nChoices is number of long elements in choices, not memory size.


Member Data Documentation

std::map< std::string, void * > OpqParameterPortFactory::delegates [private]

This is the map of port names to Parameter port delegate implementations. noone needs to know that, however.


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