openfluid::core::DatastoreItem Class Reference

#include <core/DatastoreItem.hpp>

Public Member Functions
	DatastoreItem (const std::string &ID, const std::string &PrefixPath, const std::string &RelativePath, UnstructuredValue::UnstructuredType Type, const std::string &UnitsClass="")
	Creates a new resource item. More...
	~DatastoreItem ()
	Destroys the resource and its associated value. More...
std::string	getID () const
std::string	getPrefixPath () const
	Returns the prefix path of the resource. More...
std::string	getRelativePath () const
	Returns the path of the resource, relative to prefix path. More...
std::string	getUnitsClass () const
std::string	getUnitClass () const OPENFLUID_DEPRECATED
UnstructuredValue *	value ()
	Gets the associated value of the resource. More...
const UnstructuredValue *	value () const
	Gets the associated value of the resource. More...

Detailed Description

Item of a Datastore, giving information about an additional resource.

Constructor & Destructor Documentation

openfluid::core::DatastoreItem::DatastoreItem	(	const std::string &	ID,
		const std::string &	PrefixPath,
		const std::string &	RelativePath,
		UnstructuredValue::UnstructuredType	Type,
		const std::string &	UnitsClass = ""
	)

Creates a new resource item.

Tries to create a new resource item and its associated UnstructuredValue, depending on the given type.

Parameters

ID	The ID of the item.
PrefixPath	The prefix path of the item, usually the IN directory of the project.
RelativePath	The relative path of the item from the PrefixPath
Type	The type of the item.
UnitsClass	(optional) The associated unit class of the item.

Exceptions

openfluid::base::FrameworkException

if the given type is unknown.

openfluid::core::DatastoreItem::~DatastoreItem

(

)

Destroys the resource and its associated value.

Member Function Documentation

std::string openfluid::core::DatastoreItem::getID

(

)

const

std::string openfluid::core::DatastoreItem::getPrefixPath

(

)

const

Returns the prefix path of the resource.

std::string openfluid::core::DatastoreItem::getRelativePath

(

)

const

Returns the path of the resource, relative to prefix path.

std::string openfluid::core::DatastoreItem::getUnitClass ( ) const

inline

Deprecated:

Since version 2.1.0. Use openfluid::core::DatastoreItem::getUnitsClass() instead

std::string openfluid::core::DatastoreItem::getUnitsClass

(

)

const

UnstructuredValue* openfluid::core::DatastoreItem::value

(

)

Gets the associated value of the resource.

const UnstructuredValue* openfluid::core::DatastoreItem::value

(

)

const

Gets the associated value of the resource.

---

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

• core/DatastoreItem.hpp