bpp-core  2.1.0
 All Classes Namespaces Files Functions Variables Typedefs Friends
bpp::AliasParameterListener Class Reference

Inner listener class used by AbstractParameterAliasable. More...

#include <Bpp/Numeric/AbstractParameterAliasable.h>

+ Inheritance diagram for bpp::AliasParameterListener:
+ Collaboration diagram for bpp::AliasParameterListener:

Public Member Functions

 AliasParameterListener (const std::string &id, size_t alias, ParameterList *pl)
 
 AliasParameterListener (const AliasParameterListener &apl)
 
AliasParameterListeneroperator= (const AliasParameterListener &apl)
 
AliasParameterListenerclone () const
 Create a copy of this object and send a pointer to it. More...
 
const std::string & getId () const
 
void setParameterList (ParameterList *pl)
 
void parameterNameChanged (ParameterEvent &event) throw (Exception)
 Notify a renaming action. More...
 
void parameterValueChanged (ParameterEvent &event) throw (Exception)
 Notify a value change. More...
 
const std::string & getName () const
 
void rename (const std::string &name)
 
const std::string & getAlias () const
 

Private Attributes

std::string id_
 
size_t alias_
 
ParameterListpl_
 
std::string name_
 

Detailed Description

Inner listener class used by AbstractParameterAliasable.

Definition at line 55 of file AbstractParameterAliasable.h.

Constructor & Destructor Documentation

bpp::AliasParameterListener::AliasParameterListener ( const std::string &  id,
size_t  alias,
ParameterList pl 
)
inline

Definition at line 65 of file AbstractParameterAliasable.h.

References name_.

Referenced by clone().

bpp::AliasParameterListener::AliasParameterListener ( const AliasParameterListener apl)
inline

Definition at line 75 of file AbstractParameterAliasable.h.

Member Function Documentation

AliasParameterListener* bpp::AliasParameterListener::clone ( ) const
inlinevirtual

Create a copy of this object and send a pointer to it.

Returns
A pointer toward the copy object.

Implements bpp::ParameterListener.

Definition at line 91 of file AbstractParameterAliasable.h.

References AliasParameterListener().

Referenced by bpp::AbstractParameterAliasable::AbstractParameterAliasable(), and bpp::AbstractParameterAliasable::operator=().

const std::string& bpp::AliasParameterListener::getAlias ( ) const
inline

Definition at line 112 of file AbstractParameterAliasable.h.

References pl_.

const std::string& bpp::AliasParameterListener::getId ( ) const
inlinevirtual
Returns
The identifier of this listener.

Implements bpp::ParameterListener.

Definition at line 94 of file AbstractParameterAliasable.h.

References id_.

const std::string& bpp::AliasParameterListener::getName ( ) const
inline

Definition at line 108 of file AbstractParameterAliasable.h.

References name_.

AliasParameterListener& bpp::AliasParameterListener::operator= ( const AliasParameterListener apl)
inline

Definition at line 82 of file AbstractParameterAliasable.h.

References alias_, alias_, id_, id_, name_, name_, pl_, and pl_.

void bpp::AliasParameterListener::parameterNameChanged ( ParameterEvent event) throw (Exception)
inlinevirtual

Notify a renaming action.

Parameters
eventEvent associated to the acion.

Implements bpp::ParameterListener.

Definition at line 98 of file AbstractParameterAliasable.h.

void bpp::AliasParameterListener::parameterValueChanged ( ParameterEvent event) throw (Exception)
inlinevirtual

Notify a value change.

Parameters
eventEvent associated to the acion.

Implements bpp::ParameterListener.

Definition at line 100 of file AbstractParameterAliasable.h.

References alias_, bpp::Parameter::getName(), name_, and bpp::Parameter::setValue().

void bpp::AliasParameterListener::rename ( const std::string &  name)
inline

Definition at line 110 of file AbstractParameterAliasable.h.

References name_.

void bpp::AliasParameterListener::setParameterList ( ParameterList pl)
inline

Member Data Documentation

size_t bpp::AliasParameterListener::alias_
private

Definition at line 60 of file AbstractParameterAliasable.h.

Referenced by getAlias(), operator=(), operator=(), and parameterValueChanged().

std::string bpp::AliasParameterListener::id_
private

Definition at line 59 of file AbstractParameterAliasable.h.

Referenced by getId(), operator=(), and operator=().

std::string bpp::AliasParameterListener::name_
private
ParameterList* bpp::AliasParameterListener::pl_
private

Definition at line 61 of file AbstractParameterAliasable.h.

Referenced by getAlias(), operator=(), operator=(), and setParameterList().


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