Wombat::MamaSource

More…

#include <MamaSource.h>

Inherits from Wombat::MamaSourceManager

Inherited by Wombat::MamaSourceDerivative

Public Functions

Additional inherited members

Public Classes inherited from Wombat::MamaSourceManager

Public Types inherited from Wombat::MamaSourceManager

Public Functions inherited from Wombat::MamaSourceManager

Detailed Description

class Wombat::MamaSource;

A MAMA source maintains information about a data source, including the quality of the data coming from that source. It inherits MamaSourceManager because a source can have sub-sources.

Public Functions Documentation

function MamaSource

MamaSource()

function MamaSource

MamaSource(
    const char * id,
    const char * transportName,
    const char * subscSourceName,
    mamaBridge bridge,
    bool createTransport =true
)

function MamaSource

MamaSource(
    const char * id,
    MamaTransport * transport,
    const char * subscSourceName
)

function ~MamaSource

virtual ~MamaSource()

function setId

void setId(
    const char * id
)

function setMappedId

void setMappedId(
    const char * id
)

function setDisplayId

void setDisplayId(
    const char * id
)

function setQuality

void setQuality(
    mamaQuality quality
)

function setState

void setState(
    mamaSourceState state
)

function setParent

void setParent(
    MamaSource * parent
)

function setTransport

void setTransport(
    MamaTransport * transport
)

function setTransportName

void setTransportName(
    const char * transportName
)

function setPublisherSourceName

void setPublisherSourceName(
    const char * sourceName
)

function getId

virtual const char * getId() const

function getMappedId

virtual const char * getMappedId() const

function getDisplayId

virtual const char * getDisplayId() const

function getQuality

virtual mamaQuality getQuality() const

Reimplemented by: Wombat::MamaSourceDerivative::getQuality

function getState

virtual mamaSourceState getState() const

Reimplemented by: Wombat::MamaSourceDerivative::getState

function getParent

virtual MamaSource * getParent()

function getParent

virtual const MamaSource * getParent() const

function getTransport

virtual MamaTransport * getTransport() const

function getTransportName

virtual const char * getTransportName() const

function getPublisherSourceName

virtual const char * getPublisherSourceName() const

function getCValue

mamaSource getCValue()

function getCValue

const mamaSource getCValue() const

function isPartOf

bool isPartOf(
    const MamaSource * source
) const

Is this source part of the supplied source i.e. Is it the same as the supplied source or is the supplied source a parent (or parent of a parent) of this source

function addSubscription

void addSubscription(
    const char * symbol,
    MamaSubscription * sub
)

Add a subscription.

function findSubscription

MamaSubscription * findSubscription(
    const char * symbol
)

Look up a MamaSubscription. NULL is returned if not found.

function removeSubscription

MamaSubscription * removeSubscription(
    const char * symbol
)

Remove a MamaSubscription. Subscription return is the subscription removed from list of associated subscriptions. NULL is returned if not found.

function deactivateSubscriptions

void deactivateSubscriptions()

Activate all subscriptions for this source.

function activateSubscriptions

void activateSubscriptions()

deactivate all subscriptions for this source.

function forEachSubscription

void forEachSubscription(
    MamaSubscriptionIteratorCallback * callback,
    void * closure
)

Iterate through all subscriptions and call the MamaSubscriptionIterator’s onSubscription method for each.

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