Wombat::MamaSymbolList

More…

#include <MamaSymbolList.h>

Inherited by Wombat::MamaSymbolListFile

Public Functions

Public Attributes

Protected Attributes

Detailed Description

class Wombat::MamaSymbolList;

MamaSymbolList manages a list of MAMA symbols and related attributes. Methods are provided for creating, updating and sorting the members of the list. Handler interfaces are provided so that it is possible to handle asynchronous/external changes to the symbol list, as many types of symbol lists can be quite dynamic.

Public Functions Documentation

function MamaSymbolList

MamaSymbolList()

function ~MamaSymbolList

virtual ~MamaSymbolList()

function addMembershipHandler

void addMembershipHandler(
    MamaSymbolListMembershipHandler * handler
)

Parameters:

• handler The handler to be registered.

Add a “membership” handler that implements the MamaSymbolListMembershipHandler interface. Multiple handlers may be registered.

function addMember

void addMember(
    MamaSymbolListMember * member
)

Parameters:

• member The symbol member to be added.

Add a symbol to the list. The list maintains a unique list of symbols.

function findMember

MamaSymbolListMember * findMember(
    const char * symbol,
    const char * source,
    mamaTransport transport
)

Parameters:

• symbol The name of the symbol to be removed.
• source The source of the symbol to be removed.
• transport The transport of the symbol to be removed.

Return: The object containing additional information about the symbol (or NULL).

Find a symbol in the list.

function removeMember

MamaSymbolListMember * removeMember(
    const char * symbol,
    const char * source,
    mamaTransport transport
)

Parameters:

• symbol The symbol to be removed.
• source The source of the symbol to be removed
• transport The transport of the symbol to be removed

Return: The member just removed (or NULL if not found)

Remove a symbol from the list (providing it exists in the list). The member itself is not destroyed but returned as the result of this method.

function removeMember

void removeMember(
    MamaSymbolListMember & member
)

Parameters:

• member The member to be removed.

Remove a symbol from the list (providing it exists in the list). The member itself is not destroyed.

function removeMemberAll

void removeMemberAll(
    void 
)

Remove all symbols from the list (providing it exists in the list). The member itself is not destroyed.

function clear

void clear()

Remove all symbols from the list. Handlers remain registered.

function dump

void dump()

Dump the contents of the list to stdout. For debugging.

function empty

bool empty() const

Return: whether the symbol list is empty.

function size

mama_size_t size() const

Return: the size of the symbol list.

function setClosure

void setClosure(
    void * closure
)

Parameters:

• closure The closure.

Set the closure.

function getClosure

void * getClosure() const

Return: The closure.

Get the closure.

function iterate

void iterate(
    MamaSymbolListIteratorHandler & handler,
    void * iterateClosure =NULL
)

Parameters:

• handler Handler invoked for each member of the symbol list.
• iterateClosure The closure passed to the MamaSymbolListIteratorHandler::onMember() interface.

Iterate over all members of the symbol list.

function getCValue

mamaSymbolList getCValue()

Return: The mamaSymbolList

Get the underlying Impl at C level

function getCValue

const mamaSymbolList getCValue() const

Return: The mamaSymbolList

Get the underlying Impl at C level

Public Attributes Documentation

variable myPimpl

MamaSymbolListImpl * myPimpl;

Protected Attributes Documentation

variable myList

mamaSymbolList myList;

Updated on 2023-03-31 at 15:29:25 +0100