Forcing Class Reference

Inheritance diagram for Forcing:

Public Member Functions
	Forcing (VariableType type)
void	AttachTimeSeriesData (TimeSeriesData *timeSeriesData)
VariableType	GetType ()
double	GetValue ()

Protected Attributes
VariableType	m_type
TimeSeriesData *	m_timeSeriesData

Member Function Documentation

AttachTimeSeriesData()

void Forcing::AttachTimeSeriesData

(

TimeSeriesData *

timeSeriesData

)

Attach time series data to the forcing.

Parameters

timeSeriesData

pointer to the time series data.

GetType()

VariableType Forcing::GetType ( )

inline

Get the type of the forcing.

Returns

the type of the forcing.

GetValue()

double Forcing::GetValue

(

)

Get the value of the forcing at the current time in the simulation.

Returns

the value of the forcing.

---

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

• /github/workspace/core/src/base/Forcing.h
• /github/workspace/core/src/base/Forcing.cpp