bpp-core3  3.0.0
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, const std::string &from)
 
 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
 
const std::string & getFrom () const
 
void setParameterList (ParameterList *pl)
 
void parameterNameChanged (ParameterEvent &event)
 Notify a renaming action. More...
 
void parameterValueChanged (ParameterEvent &event)
 Notify a value change. More...
 
void parameterConstraintChanged (ParameterEvent &event)
 Notify a constraint 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_
 
std::string from_
 

Detailed Description

Inner listener class used by AbstractParameterAliasable.

Definition at line 56 of file AbstractParameterAliasable.h.

Constructor & Destructor Documentation

◆ AliasParameterListener() [1/2]

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

Definition at line 67 of file AbstractParameterAliasable.h.

References name_.

Referenced by clone().

◆ AliasParameterListener() [2/2]

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

Definition at line 78 of file AbstractParameterAliasable.h.

Member Function Documentation

◆ clone()

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 96 of file AbstractParameterAliasable.h.

References AliasParameterListener().

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

◆ getAlias()

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

Definition at line 127 of file AbstractParameterAliasable.h.

References alias_, and pl_.

◆ getFrom()

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

Definition at line 101 of file AbstractParameterAliasable.h.

References from_.

◆ getId()

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

Implements bpp::ParameterListener.

Definition at line 99 of file AbstractParameterAliasable.h.

References id_.

◆ getName()

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

Definition at line 123 of file AbstractParameterAliasable.h.

References name_.

◆ operator=()

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

Definition at line 86 of file AbstractParameterAliasable.h.

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

◆ parameterConstraintChanged()

void bpp::AliasParameterListener::parameterConstraintChanged ( ParameterEvent event)
inlinevirtual

Notify a constraint change.

Parameters
eventEvent associated to the acion.

Implements bpp::ParameterListener.

Definition at line 115 of file AbstractParameterAliasable.h.

References alias_, bpp::Parameter::getConstraint(), bpp::Parameter::getName(), bpp::ParameterEvent::getParameter(), name_, and bpp::Parameter::setConstraint().

◆ parameterNameChanged()

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

Notify a renaming action.

Parameters
eventEvent associated to the acion.

Implements bpp::ParameterListener.

Definition at line 105 of file AbstractParameterAliasable.h.

◆ parameterValueChanged()

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

Notify a value change.

Parameters
eventEvent associated to the acion.

Implements bpp::ParameterListener.

Definition at line 107 of file AbstractParameterAliasable.h.

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

◆ rename()

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

Definition at line 125 of file AbstractParameterAliasable.h.

References name_.

◆ setParameterList()

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

Member Data Documentation

◆ alias_

size_t bpp::AliasParameterListener::alias_
private

◆ from_

std::string bpp::AliasParameterListener::from_
private

Definition at line 64 of file AbstractParameterAliasable.h.

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

◆ id_

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

Definition at line 60 of file AbstractParameterAliasable.h.

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

◆ name_

std::string bpp::AliasParameterListener::name_
private

◆ pl_

ParameterList* bpp::AliasParameterListener::pl_
private

Definition at line 62 of file AbstractParameterAliasable.h.

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


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