#include <DataProviderSelectors.hpp>

Collaboration diagram for CatchmentAggrDataSelector:

Public Member Functions
	CatchmentAggrDataSelector ()
	Construct a new Catchment Aggregate Data Selector object with default values.

	CatchmentAggrDataSelector (std::string id, std::string var, time_t start, long dur, std::string units)
	Construct a new Data Selector object with inital values.

std::string	get_variable_name () const
	Get the variable name for this selector.

time_t	get_init_time () const
	Get the initial time for this selector.

long	get_duration_secs () const
	Get the duration in seconds that is requested by this selector.

std::string	get_output_units () const
	Get the output units that is requested by this selector.

void	set_variable_name (std::string var)
	Set the variable name for this selector.

void	set_init_time (time_t start)
	Set the init time for this selector.

void	set_duration_secs (long dur)
	Set the duration in secs for the query represented by this selector.

void	set_output_units (std::string units)
	Set the output units for the data to be returned with this selector.

std::string	get_id () const
	Get the id string for this NetCDF Data Selector.

void	set_id (std::string s)
	Set the id string for this NetCDF Data Selector.

Private Attributes
std::string	variable_name
	The variable name that should be queried.

time_t	init_time
	The inital time to query the requested variable.

long	duration_s
	The duration of the query.

std::string	output_units
	required units for the result to be return in

std::string	id_str

Constructor & Destructor Documentation

◆ CatchmentAggrDataSelector() [1/2]

CatchmentAggrDataSelector::CatchmentAggrDataSelector ( )

inline

Construct a new Catchment Aggregate Data Selector object with default values.

◆ CatchmentAggrDataSelector() [2/2]

CatchmentAggrDataSelector::CatchmentAggrDataSelector	(	std::string	id,
		std::string	var,
		time_t	start,
		long	dur,
		std::string	units )

inline

Construct a new Data Selector object with inital values.

Parameters

var	The variable to be accessed by the selector
start	THe start time for this selector
dur	The duration for this selector
units	The units to output the result in
id	the id of the associated catchment

Member Function Documentation

◆ get_duration_secs()

long CatchmentAggrDataSelector::get_duration_secs ( ) const

inline

Get the duration in seconds that is requested by this selector.

Returns: long

References duration_s.

Referenced by CsvPerFeatureForcingProvider::get_value(), data_access::OptionalWrappedDataProvider::get_value(), realization::Bmi_Module_Formulation::get_value(), realization::Bmi_Multi_Formulation::get_value(), realization::Bmi_Module_Formulation::get_values(), and realization::Bmi_Multi_Formulation::get_values().

◆ get_id()

std::string CatchmentAggrDataSelector::get_id ( ) const

inline

Get the id string for this NetCDF Data Selector.

Returns: std::string

References id_str.

◆ get_init_time()

time_t CatchmentAggrDataSelector::get_init_time ( ) const

inline

Get the initial time for this selector.

Returns: time_t

References init_time.

Referenced by CsvPerFeatureForcingProvider::get_value(), data_access::OptionalWrappedDataProvider::get_value(), realization::Bmi_Module_Formulation::get_value(), realization::Bmi_Multi_Formulation::get_value(), realization::Bmi_Module_Formulation::get_values(), and realization::Bmi_Multi_Formulation::get_values().

◆ get_output_units()

std::string CatchmentAggrDataSelector::get_output_units ( ) const

inline

Get the output units that is requested by this selector.

Returns: std::string

References output_units.

Referenced by CsvPerFeatureForcingProvider::get_value(), data_access::OptionalWrappedDataProvider::get_value(), realization::Bmi_Module_Formulation::get_value(), realization::Bmi_Multi_Formulation::get_value(), realization::Bmi_Module_Formulation::get_values(), and realization::Bmi_Multi_Formulation::get_values().

◆ get_variable_name()

std::string CatchmentAggrDataSelector::get_variable_name ( ) const

inline

Get the variable name for this selector.

Returns: std::string

References variable_name.

Referenced by CsvPerFeatureForcingProvider::get_value(), data_access::OptionalWrappedDataProvider::get_value(), realization::Bmi_Module_Formulation::get_value(), realization::Bmi_Multi_Formulation::get_value(), realization::Bmi_Module_Formulation::get_values(), and realization::Bmi_Multi_Formulation::get_values().

◆ set_duration_secs()

void CatchmentAggrDataSelector::set_duration_secs ( long dur )

inline

Set the duration in secs for the query represented by this selector.

Parameters

dur	the duration of the query in seconds

References duration_s.

◆ set_id()

void CatchmentAggrDataSelector::set_id ( std::string s )

inline

Set the id string for this NetCDF Data Selector.

Parameters

s

References id_str.

◆ set_init_time()

void CatchmentAggrDataSelector::set_init_time ( time_t start )

inline

Set the init time for this selector.

Parameters

start The inital time for this query

References init_time.

◆ set_output_units()

void CatchmentAggrDataSelector::set_output_units ( std::string units )

inline

Set the output units for the data to be returned with this selector.

Parameters

units The units of the output

References output_units.

◆ set_variable_name()

void CatchmentAggrDataSelector::set_variable_name ( std::string var )

inline

Set the variable name for this selector.

Parameters

var	The name of the variable to access

References variable_name.

Member Data Documentation

◆ duration_s

long CatchmentAggrDataSelector::duration_s

private

The duration of the query.

Referenced by get_duration_secs(), and set_duration_secs().

◆ id_str

std::string CatchmentAggrDataSelector::id_str

private

Referenced by get_id(), and set_id().

◆ init_time

time_t CatchmentAggrDataSelector::init_time

private

The inital time to query the requested variable.

Referenced by get_init_time(), and set_init_time().

◆ output_units

std::string CatchmentAggrDataSelector::output_units

private

required units for the result to be return in

Referenced by get_output_units(), and set_output_units().

◆ variable_name

std::string CatchmentAggrDataSelector::variable_name

private

The variable name that should be queried.

Referenced by get_variable_name(), and set_variable_name().

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

include/forcing/DataProviderSelectors.hpp

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ CatchmentAggrDataSelector() [1/2]

◆ CatchmentAggrDataSelector() [2/2]

Member Function Documentation

◆ get_duration_secs()

◆ get_id()

◆ get_init_time()

◆ get_output_units()

◆ get_variable_name()

◆ set_duration_secs()

◆ set_id()

◆ set_init_time()

◆ set_output_units()

◆ set_variable_name()

Member Data Documentation

◆ duration_s

◆ id_str

◆ init_time

◆ output_units

◆ variable_name