Introduction
Documentation Home What is OpenMAMA? Supported Platforms Versioning
Tutorials
1. Quick Start 2. Using MAMA Resource Pool
User Guides
Installing OpenMAMA OpenMAMA Developer's Guide OpenMAMDA Developer's Guide API Reference Docs Portable Demo Environment IDE Integration Running Example Apps Qpid Bridge Raising Issues Performance Testing Vulnerability Reporting
Contributor Guides
Contributing to Documentation Third Party Repository Building From Source Bridge Building Documentation Bridge Developer FAQ Bridge Incorporation Guidelines Coding Standards Dynamic Bridge Loading Long Lived Feature Branches Release Process Submission Process Unit Testing
RFC Documents
Open Closed Process Template
Classes Files

Wombat::ISourceManager

A container of MamaSource objects. Because each MamaSource can contain sub-sources (and so on), MamaSource is also a source manager and implements this interface.

Inherits from IDisposable

Inherited by Wombat.MamaSource, Wombat.MamaSourceManager

Public Functions

  Name
MamaSource create(string name)
Create a new MamaSource and add it to the manager.
MamaSource findOrCreate(string name)
Locates an existing MamaSource for the given name. If none exists creates and adds a new MamaSource.
MamaSource find(string name)
Locates an existing MamaSource with the specified string ‘name’ identifier. Returns null if no source was located.
void add(MamaSource source)
Add an existing MamaSource. The id of the source will be used instead of the name to uniquely identify the source within the manager.
void add(string name, MamaSource source)
Add an existing MamaSource using the specified name as a unique identifier.

Public Functions Documentation

function create

MamaSource create(
    string name
)

Create a new MamaSource and add it to the manager.

Parameters:

Return: The created MamaSource object if execution is successful.

Reimplemented by: Wombat::MamaSource::create, Wombat::MamaSourceManager::create

function findOrCreate

MamaSource findOrCreate(
    string name
)

Locates an existing MamaSource for the given name. If none exists creates and adds a new MamaSource.

Parameters:

Return: The MamaSource object if execution is successful.

Reimplemented by: Wombat::MamaSource::findOrCreate, Wombat::MamaSourceManager::findOrCreate

function find

MamaSource find(
    string name
)

Locates an existing MamaSource with the specified string ‘name’ identifier. Returns null if no source was located.

Parameters:

  • name The string identifier for the required MamaSource

Return: The MamaSource object if found, or null if not found (if execution is successful)

Reimplemented by: Wombat::MamaSource::find, Wombat::MamaSourceManager::find

function add

void add(
    MamaSource source
)

Add an existing MamaSource. The id of the source will be used instead of the name to uniquely identify the source within the manager.

Parameters:

Reimplemented by: Wombat::MamaSource::add, Wombat::MamaSourceManager::add

function add

void add(
    string name,
    MamaSource source
)

Add an existing MamaSource using the specified name as a unique identifier.

Parameters:

Reimplemented by: Wombat::MamaSource::add, Wombat::MamaSourceManager::add

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