openfluid::fluidx::DatastoreDescriptor Class Reference

#include <fluidx/DatastoreDescriptor.hpp>

Public Types
typedef std::list< DatastoreItemDescriptor * >	DatastoreDescription_t

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

Member Typedef Documentation

DatastoreDescription_t

typedef std::list<DatastoreItemDescriptor*> openfluid::fluidx::DatastoreDescriptor::DatastoreDescription_t

Constructor & Destructor Documentation

DatastoreDescriptor()

openfluid::fluidx::DatastoreDescriptor::DatastoreDescriptor ( )

default

~DatastoreDescriptor()

openfluid::fluidx::DatastoreDescriptor::~DatastoreDescriptor ( )

inline

Member Function Documentation

appendItem()

bool openfluid::fluidx::DatastoreDescriptor::appendItem

(

DatastoreItemDescriptor *

Item

)

getItems() [1/2]

DatastoreDescription_t openfluid::fluidx::DatastoreDescriptor::getItems

(

const openfluid::core::UnitsClass_t &

UnitClass

)

const

getItems() [2/2]

DatastoreDescription_t openfluid::fluidx::DatastoreDescriptor::getItems	(	const openfluid::core::UnitsClass_t &	UnitClass,
		openfluid::core::UnstructuredValue::UnstructuredType	Type
	)		const

getItemsIDs()

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

(

)

const

insertItem()

void openfluid::fluidx::DatastoreDescriptor::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::FrameworkException

if Position is out of range

isItemExist()

bool openfluid::fluidx::DatastoreDescriptor::isItemExist

(

const std::string &

ItemID

)

const

item()

openfluid::fluidx::DatastoreItemDescriptor* openfluid::fluidx::DatastoreDescriptor::item

(

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.

items() [1/2]

DatastoreDescription_t& openfluid::fluidx::DatastoreDescriptor::items

(

)

items() [2/2]

const DatastoreDescription_t& openfluid::fluidx::DatastoreDescriptor::items

(

)

const

moveItem()

void openfluid::fluidx::DatastoreDescriptor::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::FrameworkException

a position is out of range

removeItem()

void openfluid::fluidx::DatastoreDescriptor::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::FrameworkException

if Position is out of range

---

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

• fluidx/DatastoreDescriptor.hpp