openfluid::core::DatastoreItem Class Reference

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

List of all members.

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

---

Detailed Description

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

---

Constructor & Destructor Documentation

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

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.
UnitClass	(optional) The associated unit class of the item.

Exceptions:

openfluid::base::OFException

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

UnstructuredValue* openfluid::core::DatastoreItem::getValue

(

)

Gets the associated value of the resource.

const UnstructuredValue* openfluid::core::DatastoreItem::getValue

(

)

const

Gets the associated value of the resource.