openfluid::core::HydroObject Class Reference

Inherited by openfluid::core::GroundwaterUnit, openfluid::core::ReachSegment, and openfluid::core::SurfaceUnit.

List of all members.

Public Member Functions
	HydroObject ()
	HydroObject (UnitID ID, int ProcessOrder)
virtual	~HydroObject ()
UnitID	getID () const
int	getProcessOrder () const
void	setProcessOrder (const int ProcessOrder)
SimulatedVarsMap *	getSimulatedVars ()
SimulatedVectorVarsMap *	getSimulatedVectorVars ()
PropertiesMap *	getProperties ()
PropertiesMap *	getIniConditions ()
EventCollection *	getEvents ()

---

Detailed Description

Generic definition class for homogeneous units

Author:

Jean-Christophe FABRE <fabrejc@supagro.inra.fr>

---

Constructor & Destructor Documentation

openfluid::core::HydroObject::HydroObject

(

)

Default constructor

openfluid::core::HydroObject::HydroObject	(	UnitID	ID,
		int	ProcessOrder
	)

Constructor

Parameters:

[in]	ID	The unit identifier
[in]	ProcessOrder	the process order of the unit during the model execution

virtual openfluid::core::HydroObject::~HydroObject

(

)

[virtual]

Virtual destructor

---

Member Function Documentation

UnitID openfluid::core::HydroObject::getID

(

)

const

Returns the ID of the unit

int openfluid::core::HydroObject::getProcessOrder

(

)

const

Returns the process order of the unit

void openfluid::core::HydroObject::setProcessOrder

(

const int

ProcessOrder

)

Sets the process order of the unit

SimulatedVarsMap* openfluid::core::HydroObject::getSimulatedVars

(

)

[inline]

Returns the set of simulated scalar variables of the unit

SimulatedVectorVarsMap* openfluid::core::HydroObject::getSimulatedVectorVars

(

)

[inline]

Returns the set of simulated vector variables of the unit

PropertiesMap* openfluid::core::HydroObject::getProperties

(

)

[inline]

Returns the set of properties of the unit

PropertiesMap* openfluid::core::HydroObject::getIniConditions

(

)

[inline]

Returns the initial conditions of the unit

EventCollection* openfluid::core::HydroObject::getEvents

(

)

[inline]

Returns the set of events associated with the unit