Ocean::Test::TestDataManager Class Reference

The class implements the manager for test data collections as a singleton object. More...

#include <TestDataManager.h>

Inheritance diagram for Ocean::Test::TestDataManager:

Public Types
using	ScopedSubscription = ScopedSubscriptionT< std::string, TestDataManager >
	Definition of a scoped subscription object for for data collections.
using	ScopedSubscriptions = std::vector< ScopedSubscription >
	Definition of a vector holding scoped subscription objects.

Public Member Functions
SharedTestDataCollection	testDataCollection (const std::string &name) const
	Returns a specific test data collection.
ScopedSubscription	registerTestDataCollection (const std::string &name, std::unique_ptr< TestDataCollection > &&testDataCollection)
	Registers a new test data collection.

Protected Types
using	TestDataCollectionPair = std::pair< unsigned int, std::shared_ptr< TestDataCollection > >
	Definition of a pair combining a counter with a shared pointer.
using	TestDataCollectionMap = std::unordered_map< std::string, TestDataCollectionPair >
	Definition of an unordered map mapping collection names to collection objects.

Protected Member Functions
	TestDataManager ()
	Protected default constructor.
void	unregisterTestDataCollection (const std::string &name)
	Unregisters a registered data collection.
Protected Member Functions inherited from Ocean::Singleton< TestDataManager >
	Singleton ()=default
	Default constructor.

Protected Attributes
TestDataCollectionMap	testDataCollectionMap_
	The map mapping collection names to collection objects.
Lock	lock_
	The manager's lock.

Friends
class	Singleton< TestDataManager >
class	TestDataCollection

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Singleton< TestDataManager >
static TestDataManager &	get ()
	Returns a reference to the unique object.

Detailed Description

The class implements the manager for test data collections as a singleton object.

Member Typedef Documentation

ScopedSubscription

using Ocean::Test::TestDataManager::ScopedSubscription = ScopedSubscriptionT<std::string, TestDataManager>

Definition of a scoped subscription object for for data collections.

ScopedSubscriptions

using Ocean::Test::TestDataManager::ScopedSubscriptions = std::vector<ScopedSubscription>

Definition of a vector holding scoped subscription objects.

TestDataCollectionMap

using Ocean::Test::TestDataManager::TestDataCollectionMap = std::unordered_map<std::string, TestDataCollectionPair>

protected

Definition of an unordered map mapping collection names to collection objects.

TestDataCollectionPair

using Ocean::Test::TestDataManager::TestDataCollectionPair = std::pair<unsigned int, std::shared_ptr<TestDataCollection> >

protected

Definition of a pair combining a counter with a shared pointer.

Constructor & Destructor Documentation

TestDataManager()

Ocean::Test::TestDataManager::TestDataManager ( )

protected

Protected default constructor.

Member Function Documentation

registerTestDataCollection()

ScopedSubscription Ocean::Test::TestDataManager::registerTestDataCollection	(	const std::string &	name,
		std::unique_ptr< TestDataCollection > &&	testDataCollection
	)

Registers a new test data collection.

Parameters

name	The name of the new collection, be valid, must not exist already
testDataCollection	The new test data collection to register, must be valid

Returns

The scoped subscription object associated with the data collection, the collection will be registered as long as the scoped subscription object exists

testDataCollection()

SharedTestDataCollection Ocean::Test::TestDataManager::testDataCollection

(

const std::string &

name

)

const

Returns a specific test data collection.

Parameters

name	The name of the test data collection to return, must be valid

Returns

The requested test data collection, nullptr if it does not exist

unregisterTestDataCollection()

void Ocean::Test::TestDataManager::unregisterTestDataCollection ( const std::string &  name )

protected

Unregisters a registered data collection.

Parameters

name	The name of the data collection to unregister, must be valid

Friends And Related Symbol Documentation

Singleton< TestDataManager >

friend class Singleton< TestDataManager >

friend

TestDataCollection

friend class TestDataCollection

friend

Field Documentation

lock_

Lock Ocean::Test::TestDataManager::lock_

mutableprotected

The manager's lock.

testDataCollectionMap_

TestDataCollectionMap Ocean::Test::TestDataManager::testDataCollectionMap_

protected

The map mapping collection names to collection objects.

---

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

• TestDataManager.h