openfluid::fluidx::AdvancedDatastoreDescriptor Class Reference

#include <fluidx/AdvancedDatastoreDescriptor.hpp>

Public Member Functions
	AdvancedDatastoreDescriptor (openfluid::fluidx::DatastoreDescriptor &DatastoreDesc)
	~AdvancedDatastoreDescriptor ()
const std::list < openfluid::fluidx::DatastoreItemDescriptor * > &	getItems () const
std::list < openfluid::fluidx::DatastoreItemDescriptor * >	getItems (const std::string &UnitClass) const
std::list < openfluid::fluidx::DatastoreItemDescriptor * >	getItems (const std::string &UnitClass, openfluid::core::UnstructuredValue::UnstructuredType Type) const
void	moveItem (unsigned int From, unsigned int To)
void	appendItem (openfluid::fluidx::DatastoreItemDescriptor *Item)
void	insertItem (openfluid::fluidx::DatastoreItemDescriptor *Item, unsigned int Position)
void	removeItem (unsigned int Position)
std::list< std::string >	getItemsIDs () const
bool	isItemAlreadyExist (std::string ItemID) const
openfluid::fluidx::DatastoreItemDescriptor *	getItem (const std::string &ItemID)
	Gets the item of the datastore matching the given ID. More...

Constructor & Destructor Documentation

openfluid::fluidx::AdvancedDatastoreDescriptor::AdvancedDatastoreDescriptor

(

openfluid::fluidx::DatastoreDescriptor &

DatastoreDesc

)

openfluid::fluidx::AdvancedDatastoreDescriptor::~AdvancedDatastoreDescriptor

(

)

Member Function Documentation

void openfluid::fluidx::AdvancedDatastoreDescriptor::appendItem

(

openfluid::fluidx::DatastoreItemDescriptor *

Item

)

openfluid::fluidx::DatastoreItemDescriptor* openfluid::fluidx::AdvancedDatastoreDescriptor::getItem

(

const std::string &

ItemID

)

Gets the item of the datastore matching the given ID.

Parameters

ItemID

ID of the expected item.

Returns

The item with the given ID, or 0 if not found.

const std::list<openfluid::fluidx::DatastoreItemDescriptor*>& openfluid::fluidx::AdvancedDatastoreDescriptor::getItems

(

)

const

std::list<openfluid::fluidx::DatastoreItemDescriptor*> openfluid::fluidx::AdvancedDatastoreDescriptor::getItems

(

const std::string &

UnitClass

)

const

std::list<openfluid::fluidx::DatastoreItemDescriptor*> openfluid::fluidx::AdvancedDatastoreDescriptor::getItems	(	const std::string &	UnitClass,
		openfluid::core::UnstructuredValue::UnstructuredType	Type
	)		const

std::list<std::string> openfluid::fluidx::AdvancedDatastoreDescriptor::getItemsIDs

(

)

const

void openfluid::fluidx::AdvancedDatastoreDescriptor::insertItem	(	openfluid::fluidx::DatastoreItemDescriptor *	Item,
		unsigned int	Position
	)

Insert an Item before the given position (positions starts at index 0)

Parameters

[in]	Item	the DatastoreItemDescriptor to insert
[in]	Position	the position, should be between zero and list size - 1. To insert an Item at the end of the list, use appendItem instead.

Exceptions

openfluid::base::OFException

if Position is out of range

bool openfluid::fluidx::AdvancedDatastoreDescriptor::isItemAlreadyExist

(

std::string

ItemID

)

const

void openfluid::fluidx::AdvancedDatastoreDescriptor::moveItem	(	unsigned int	From,
		unsigned int	To
	)

Move the Item located at the given From position to the To position (positions starts at index 0)

Parameters

From
To

Exceptions

openfluid::base::OFException

a position is out of range

void openfluid::fluidx::AdvancedDatastoreDescriptor::removeItem

(

unsigned int

Position

)

Remove from the list the Item located at the given Position (positions starts at index 0). This doesn't delete the DatastoreItemDescriptor pointer.

Parameters

[in]

Position

the position

Exceptions

openfluid::base::OFException

if Position is out of range

---

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

• fluidx/AdvancedDatastoreDescriptor.hpp