Forcing Class Reference

Inheritance diagram for Forcing:

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

Protected Attributes
VariableType	_type
TimeSeriesData *	_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 ( ) const

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.

IsValid()

bool Forcing::IsValid ( ) const

nodiscard

Check if the forcing is valid. Verifies that time series data is attached.

Returns

true if the forcing is valid, false otherwise.

Validate()

void Forcing::Validate

(

)

const

Validate the forcing. Throws an exception if the forcing is invalid.

Exceptions

ModelConfigError

if validation fails.

---

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