NEOCCA bindings Specification  0.2.8
Public Member Functions | List of all members
neo::cca::ports::BasicParameterPort Class Referenceabstract

simple version just exposing the typemap. More...

#include <BasicParameterPort.hh>

Inheritance diagram for neo::cca::ports::BasicParameterPort:
Inheritance graph
[legend]
Collaboration diagram for neo::cca::ports::BasicParameterPort:
Collaboration graph
[legend]

Public Member Functions

virtual ~BasicParameterPort ()
 
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...
 
- Public Member Functions inherited from neo::cca::Port
virtual ~Port ()
 obligatory virtual destructor More...
 

Detailed Description

simple version just exposing the typemap.

The only values in the typemap a component thus exposes that can be changed are those returned from readConfigurationKeys.

Constructor & Destructor Documentation

◆ ~BasicParameterPort()

virtual neo::cca::ports::BasicParameterPort::~BasicParameterPort ( )
inlinevirtual
18 {}

Member Function Documentation

◆ readConfigurationKeys()

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

return the names of available parameter maps.

Implemented in neo::cca::ports::ParameterPort.

◆ readConfigurationMap()

virtual neo::cca::TypeMap_shared neo::cca::ports::BasicParameterPort::readConfigurationMap ( )
throw (neo::cca::Exception
)
pure virtual

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

Implemented in neo::cca::ports::ParameterPort.

◆ writeConfigurationMap()

virtual void neo::cca::ports::BasicParameterPort::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. I.e. only the values from tm with keys matching those in readConfigurationKeys will be taken.

Implemented in neo::cca::ports::ParameterPort.


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