realization::Bmi_Var_Details Class Reference

Type to hold some certain details about a BMI module variable that the framework will need to use repeatedly. More...

#include <Bmi_Module_Formulation.hpp>

Collaboration diagram for realization::Bmi_Var_Details:

Public Member Functions
	Bmi_Var_Details (std::string name, std::string alias, const int item_size, const int num_items, std::string cpp_type, std::string units)
	Bmi_Var_Details (const Bmi_Var_Details &source)=default
const std::string &	get_name () const
const std::string &	get_mapped_alias () const
const std::string &	get_cpp_type () const
const std::string &	get_units () const
int	get_item_size () const
int	get_num_items () const

Private Attributes
const std::string	name
	The module's publicized name for this variable.
const std::string	mapped_alias
	The framework's configured alias for the variable.
const std::string	cpp_type
	String for the C++ type corresponding to this variable's type.
const std::string	units
	String for variable's units.
int	item_size
	The size of individual items for this variable.
int	num_items
	The number of items for this variable.

Friends
bool	operator< (const Bmi_Var_Details &lhs, const Bmi_Var_Details &rhs)

Detailed Description

Type to hold some certain details about a BMI module variable that the framework will need to use repeatedly.

Constructor & Destructor Documentation

Bmi_Var_Details() [1/2]

realization::Bmi_Var_Details::Bmi_Var_Details ( std::string name, std::string alias, const int item_size, const int num_items, std::string cpp_type, std::string units )

inline

Bmi_Var_Details() [2/2]

realization::Bmi_Var_Details::Bmi_Var_Details ( const Bmi_Var_Details & source )

default

Member Function Documentation

get_cpp_type()

const std::string & realization::Bmi_Var_Details::get_cpp_type ( ) const

inline

References cpp_type.

Referenced by realization::Bmi_Module_Formulation::perform_set().

get_item_size()

int realization::Bmi_Var_Details::get_item_size ( ) const

inline

References item_size.

get_mapped_alias()

const std::string & realization::Bmi_Var_Details::get_mapped_alias ( ) const

inline

References mapped_alias.

Referenced by realization::Bmi_Module_Formulation::perform_set().

get_name()

const std::string & realization::Bmi_Var_Details::get_name ( ) const

inline

References name.

Referenced by realization::Bmi_Module_Formulation::perform_set().

get_num_items()

int realization::Bmi_Var_Details::get_num_items ( ) const

inline

References num_items.

Referenced by realization::Bmi_Module_Formulation::perform_set().

get_units()

const std::string & realization::Bmi_Var_Details::get_units ( ) const

inline

References units.

Referenced by realization::Bmi_Module_Formulation::perform_set().

Friends And Related Symbol Documentation

operator<

bool operator< ( const Bmi_Var_Details & lhs, const Bmi_Var_Details & rhs )

friend

Member Data Documentation

cpp_type

const std::string realization::Bmi_Var_Details::cpp_type

private

String for the C++ type corresponding to this variable's type.

Referenced by get_cpp_type().

item_size

int realization::Bmi_Var_Details::item_size

private

The size of individual items for this variable.

Referenced by get_item_size().

mapped_alias

const std::string realization::Bmi_Var_Details::mapped_alias

private

The framework's configured alias for the variable.

Referenced by get_mapped_alias().

name

const std::string realization::Bmi_Var_Details::name

private

The module's publicized name for this variable.

Referenced by get_name().

num_items

int realization::Bmi_Var_Details::num_items

private

The number of items for this variable.

Referenced by get_num_items().

units

const std::string realization::Bmi_Var_Details::units

private

String for variable's units.

Referenced by get_units().

---

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

• include/realizations/catchment/Bmi_Module_Formulation.hpp