NANDRAD Data Model Library  Version 2.0
NANDRAD
NANDRAD::FMIDescription Class Reference

Detailed Description

Contains all data to generate a modelDescription.xml and configure the NANDRAD FMI Slave.

Definition at line 37 of file NANDRAD_FMIDescription.h.

#include <NANDRAD_FMIDescription.h>

Public Member Functions

NANDRAD_READWRITE void checkParameters ()
 Checks all input and output variables. More...
 
bool hasInputVariable (const FMIVariableDefinition &var) const
 Tests if an input variable for this model quantity exists already in the variable list. More...
 
bool hasOutputVariable (const FMIVariableDefinition &var) const
 Tests if an output variable for this model quantity exists already in the variable list. More...
 

Public Attributes

std::string m_modelName
 The FMI model name. More...
 
std::vector< FMIVariableDefinitionm_inputVariables
 Holds all input variable definitions. More...
 
std::vector< FMIVariableDefinitionm_outputVariables
 Holds all output variable definitions. More...
 

Member Function Documentation

◆ checkParameters()

NANDRAD_READWRITE void NANDRAD::FMIDescription::checkParameters ( )

Checks all input and output variables.

◆ hasInputVariable()

bool NANDRAD::FMIDescription::hasInputVariable ( const FMIVariableDefinition var) const

Tests if an input variable for this model quantity exists already in the variable list.

Only the NANDRAD model variable properties (name, objectID, vector index/id) are compared.

◆ hasOutputVariable()

bool NANDRAD::FMIDescription::hasOutputVariable ( const FMIVariableDefinition var) const

Tests if an output variable for this model quantity exists already in the variable list.

Only the NANDRAD model variable properties (name, objectID, vector index/id) are compared.

Member Data Documentation

◆ m_modelName

std::string NANDRAD::FMIDescription::m_modelName

The FMI model name.

Definition at line 60 of file NANDRAD_FMIDescription.h.

◆ m_inputVariables

std::vector<FMIVariableDefinition> NANDRAD::FMIDescription::m_inputVariables

Holds all input variable definitions.

Note: There may be several input variables with same valueRef and name, yet different NANDRAD variable names. In this case, only one FMI input variable is mapped to all NANDRAD variables.

Definition at line 67 of file NANDRAD_FMIDescription.h.

◆ m_outputVariables

std::vector<FMIVariableDefinition> NANDRAD::FMIDescription::m_outputVariables

Holds all output variable definitions.

Definition at line 69 of file NANDRAD_FMIDescription.h.


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