NANDRAD::FMIVariableDefinition Class Reference

Detailed Description

Definition of an FMI input/output variable and the corresponding value reference info for NANDRAD.

Definition at line 35 of file NANDRAD_FMIVariableDefinition.h.

#include <NANDRAD_FMIVariableDefinition.h>

Public Member Functions
NANDRAD_READWRITE void	checkParameters ()
	Checks variable names. More...
bool	operator< (const FMIVariableDefinition &other) const
bool	sameModelVarAs (const FMIVariableDefinition &other) const
	Compares NANDRAD model variable definitions (not FMI variables). More...

Public Attributes
std::string	m_fmiVarName
	The variable name as it appears in the FMI model description. More...
std::string	m_fmiVarDescription
	Optional description of the variable. More...
std::string	m_unit
	Unit of the variable. More...
std::string	m_fmiTypeName
	The variable variable type as it appears in the FMI model description. More...
IDType	m_fmiValueRef = NANDRAD::INVALID_ID
	The unqiue variable reference number for the FMI model description. More...
double	m_fmiStartValue
	The start value to be used for this variable. More...
std::string	m_varName
	The variable name for the variable reference in NANDRAD. More...
IDType	m_objectId = NANDRAD::INVALID_ID
	The ID of the referenced object. More...
IDType	m_vectorIndex = NANDRAD::INVALID_ID
	Vector ID/Index for vector valued quantities. More...

Member Function Documentation

checkParameters()

NANDRAD_READWRITE void NANDRAD::FMIVariableDefinition::checkParameters

(

)

Checks variable names.

sameModelVarAs()

bool NANDRAD::FMIVariableDefinition::sameModelVarAs ( const FMIVariableDefinition &  other ) const

inline

Compares NANDRAD model variable definitions (not FMI variables).

Definition at line 69 of file NANDRAD_FMIVariableDefinition.h.

Member Data Documentation

m_fmiVarName

std::string NANDRAD::FMIVariableDefinition::m_fmiVarName

The variable name as it appears in the FMI model description.

Definition at line 76 of file NANDRAD_FMIVariableDefinition.h.

m_fmiVarDescription

std::string NANDRAD::FMIVariableDefinition::m_fmiVarDescription

Optional description of the variable.

Definition at line 78 of file NANDRAD_FMIVariableDefinition.h.

m_unit

std::string NANDRAD::FMIVariableDefinition::m_unit

Unit of the variable.

Definition at line 80 of file NANDRAD_FMIVariableDefinition.h.

m_fmiTypeName

std::string NANDRAD::FMIVariableDefinition::m_fmiTypeName

The variable variable type as it appears in the FMI model description.

Definition at line 82 of file NANDRAD_FMIVariableDefinition.h.

m_fmiValueRef

IDType NANDRAD::FMIVariableDefinition::m_fmiValueRef = NANDRAD::INVALID_ID

The unqiue variable reference number for the FMI model description.

Definition at line 84 of file NANDRAD_FMIVariableDefinition.h.

m_fmiStartValue

double NANDRAD::FMIVariableDefinition::m_fmiStartValue

The start value to be used for this variable.

Definition at line 86 of file NANDRAD_FMIVariableDefinition.h.

m_varName

std::string NANDRAD::FMIVariableDefinition::m_varName

The variable name for the variable reference in NANDRAD.

This is an encoded name in format <objectRefType>.<variableName>, for example 'Zone.AirTemperature'.

Definition at line 92 of file NANDRAD_FMIVariableDefinition.h.

m_objectId

IDType NANDRAD::FMIVariableDefinition::m_objectId = NANDRAD::INVALID_ID

The ID of the referenced object.

Definition at line 94 of file NANDRAD_FMIVariableDefinition.h.

m_vectorIndex

IDType NANDRAD::FMIVariableDefinition::m_vectorIndex = NANDRAD::INVALID_ID

Vector ID/Index for vector valued quantities.

Definition at line 96 of file NANDRAD_FMIVariableDefinition.h.

---

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

• NANDRAD_FMIVariableDefinition.h