openfluid::tools::MulticolDistributionBindings Class Reference

#include <tools/DistributionBindings.hpp>

Public Types
typedef std::map< std::vector< std::string >, unsigned int >	TripletLocation_t
Public Types inherited from openfluid::tools::GenericDistributionBindings< std::vector< std::string > >
typedef std::list< ReaderNextValue< std::vector< std::string > > >	ReadersNextValues_t

Public Member Functions
	MulticolDistributionBindings (const std::string &DataFile, const std::string &DateFormat="%Y%m%dT%H%M%S", const std::string &ColSeparators=";")
int	getValue (const openfluid::core::UnitsClass_t &UnitsClass, const openfluid::core::UnitID_t &UnitID, const openfluid::core::VariableName_t &VariableName, const openfluid::core::DateTime &DT, openfluid::core::DoubleValue &Value)
TripletLocation_t	getColBySelectionTriplet ()
Public Member Functions inherited from openfluid::tools::GenericDistributionBindings< std::vector< std::string > >
	GenericDistributionBindings ()=default
	~GenericDistributionBindings ()
void	advanceToTime (const openfluid::core::DateTime &DT)
bool	advanceToNextTimeAfter (const openfluid::core::DateTime &DT, openfluid::core::DateTime &NextDT)

Additional Inherited Members
Protected Attributes inherited from openfluid::tools::GenericDistributionBindings< std::vector< std::string > >
ReadersNextValues_t	m_ReadersNextValues

Inheritance diagram for openfluid::tools::MulticolDistributionBindings:

Collaboration diagram for openfluid::tools::MulticolDistributionBindings:

Member Typedef Documentation

TripletLocation_t

typedef std::map<std::vector<std::string>, unsigned int> openfluid::tools::MulticolDistributionBindings::TripletLocation_t

Constructor & Destructor Documentation

MulticolDistributionBindings()

openfluid::tools::MulticolDistributionBindings::MulticolDistributionBindings	(	const std::string &	DataFile,
		const std::string &	DateFormat = "%Y%m%dT%H%M%S",
		const std::string &	ColSeparators = ";"
	)

Member Function Documentation

getColBySelectionTriplet()

TripletLocation_t openfluid::tools::MulticolDistributionBindings::getColBySelectionTriplet ( )

inline

getValue()

int openfluid::tools::MulticolDistributionBindings::getValue	(	const openfluid::core::UnitsClass_t &	UnitsClass,
		const openfluid::core::UnitID_t &	UnitID,
		const openfluid::core::VariableName_t &	VariableName,
		const openfluid::core::DateTime &	DT,
		openfluid::core::DoubleValue &	Value
	)

Apply to Value the wanted value from distribution table for given variable at given time

Returns

the status as int: 1 for success, 0 for expected NA, -1 for failed conversion from string to double

Exceptions

openfluid::base::FrameworkException

when wrong number of columns

---

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

• tools/DistributionBindings.hpp