OpenMAMA C++ API
Wombat::MamaSymbolListMembershipHandler Class Referenceabstract

The MamaSymbolListMembershipHandler interface. More...

#include <MamaSymbolListHandlerTypes.h>

Public Member Functions

virtual ~MamaSymbolListMembershipHandler ()
 
virtual void onMemberAdd (MamaSymbolList &symbolList, MamaSymbolListMember &member)=0
 Method invoked when a symbol has been added to the list. More...
 
virtual void onMemberRemove (MamaSymbolList &symbolList, MamaSymbolListMember &member)=0
 Method invoked immediately prior to a symbol being removed from the list. More...
 
virtual void onOrderChange (MamaSymbolList &symbolList)=0
 Method invoked when the sorting of the symbol list has changed. More...
 

Detailed Description

The MamaSymbolListMembershipHandler interface.

Instances of subclasses of this class can be registered with a MamaSymbolList in order to be notified of symbol add/remove events to the symbol list.

Constructor & Destructor Documentation

§ ~MamaSymbolListMembershipHandler()

virtual Wombat::MamaSymbolListMembershipHandler::~MamaSymbolListMembershipHandler ( )
inlinevirtual

Member Function Documentation

§ onMemberAdd()

virtual void Wombat::MamaSymbolListMembershipHandler::onMemberAdd ( MamaSymbolList symbolList,
MamaSymbolListMember member 
)
pure virtual

Method invoked when a symbol has been added to the list.

Invocation of this function is conditional and is subject to a positive return (true) from the prior invocation of onDeclareInterest where the registered object has the opportunity to declare their interest in subsequent events on the given symbol.

Parameters
symbolListThe symbolList.
memberThe member just added to the list.

§ onMemberRemove()

virtual void Wombat::MamaSymbolListMembershipHandler::onMemberRemove ( MamaSymbolList symbolList,
MamaSymbolListMember member 
)
pure virtual

Method invoked immediately prior to a symbol being removed from the list.

Invocation of this function is conditional and is subject to a positive return (true) from the prior invocation of onDeclareInterest where the registered object has the opportunity to declare their interest in subsequent events on the given symbol.

Parameters
symbolListThe symbolList.
memberThe member just removed from the list.

§ onOrderChange()

virtual void Wombat::MamaSymbolListMembershipHandler::onOrderChange ( MamaSymbolList symbolList)
pure virtual

Method invoked when the sorting of the symbol list has changed.

Parameters
symbolListThe symbol list.