OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment that supports ordinary (i.e., non-delayed) and TLM connections.
Public Member Functions | Private Attributes | Friends | List of all members
oms::Variable Class Reference

#include <Variable.h>

Collaboration diagram for oms::Variable:
Collaboration graph

Public Member Functions

 Variable (fmi2_import_variable_t *var, unsigned int index)
 
 ~Variable ()
 
void markAsState ()
 
bool isParameter () const
 
bool isCalculatedParameter () const
 
bool isInput () const
 
bool isOutput () const
 
bool isLocal () const
 
bool isState () const
 
bool isIndependent () const
 
bool isExact () const
 
bool isApprox () const
 
bool isCalculated () const
 
bool isInitialUnknown () const
 
const ComRefgetCref () const
 
 operator std::string () const
 
fmi2_value_reference_t getValueReference () const
 
oms_signal_type_enu_t getType () const
 
const std::string & getDescription () const
 
bool isTypeReal () const
 
bool isTypeInteger () const
 
bool isTypeBoolean () const
 
std::string getCausalityString ()
 
oms_causality_enu_t getCausality () const
 
unsigned int getIndex () const
 
oms::Connector makeConnector () const
 

Private Attributes

ComRef cref
 
std::string description
 
fmi2_value_reference_t vr
 
fmi2_causality_enu_t causality
 
fmi2_initial_enu_t initialProperty
 
bool is_state
 
oms_signal_type_enu_t type
 
unsigned int index
 index origin = 1 More...
 

Friends

bool operator== (const oms::Variable &v1, const oms::Variable &v2)
 
bool operator!= (const oms::Variable &v1, const oms::Variable &v2)
 

Constructor & Destructor Documentation

◆ Variable()

oms::Variable::Variable ( fmi2_import_variable_t *  var,
unsigned int  index 
)
Here is the call graph for this function:

◆ ~Variable()

oms::Variable::~Variable ( )

Member Function Documentation

◆ getCausality()

oms_causality_enu_t oms::Variable::getCausality ( ) const
Here is the caller graph for this function:

◆ getCausalityString()

std::string oms::Variable::getCausalityString ( )
inline
Here is the call graph for this function:

◆ getCref()

const ComRef& oms::Variable::getCref ( ) const
inline
Here is the caller graph for this function:

◆ getDescription()

const std::string& oms::Variable::getDescription ( ) const
inline

◆ getIndex()

unsigned int oms::Variable::getIndex ( ) const
inline

◆ getType()

oms_signal_type_enu_t oms::Variable::getType ( ) const
inline

◆ getValueReference()

fmi2_value_reference_t oms::Variable::getValueReference ( ) const
inline
Here is the caller graph for this function:

◆ isApprox()

bool oms::Variable::isApprox ( ) const
inline
Here is the caller graph for this function:

◆ isCalculated()

bool oms::Variable::isCalculated ( ) const
inline
Here is the caller graph for this function:

◆ isCalculatedParameter()

bool oms::Variable::isCalculatedParameter ( ) const
inline
Here is the caller graph for this function:

◆ isExact()

bool oms::Variable::isExact ( ) const
inline

◆ isIndependent()

bool oms::Variable::isIndependent ( ) const
inline

◆ isInitialUnknown()

bool oms::Variable::isInitialUnknown ( ) const
inline
Here is the call graph for this function:

◆ isInput()

bool oms::Variable::isInput ( ) const
inline

◆ isLocal()

bool oms::Variable::isLocal ( ) const
inline

◆ isOutput()

bool oms::Variable::isOutput ( ) const
inline
Here is the caller graph for this function:

◆ isParameter()

bool oms::Variable::isParameter ( ) const
inline

◆ isState()

bool oms::Variable::isState ( ) const
inline
Here is the caller graph for this function:

◆ isTypeBoolean()

bool oms::Variable::isTypeBoolean ( ) const
inline
Here is the caller graph for this function:

◆ isTypeInteger()

bool oms::Variable::isTypeInteger ( ) const
inline
Here is the caller graph for this function:

◆ isTypeReal()

bool oms::Variable::isTypeReal ( ) const
inline
Here is the caller graph for this function:

◆ makeConnector()

oms::Connector oms::Variable::makeConnector ( ) const
inline
Here is the call graph for this function:

◆ markAsState()

void oms::Variable::markAsState ( )
inline

◆ operator std::string()

oms::Variable::operator std::string ( ) const
inline

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const oms::Variable v1,
const oms::Variable v2 
)
friend

◆ operator==

bool operator== ( const oms::Variable v1,
const oms::Variable v2 
)
friend

Member Data Documentation

◆ causality

fmi2_causality_enu_t oms::Variable::causality
private

◆ cref

ComRef oms::Variable::cref
private

◆ description

std::string oms::Variable::description
private

◆ index

unsigned int oms::Variable::index
private

index origin = 1

◆ initialProperty

fmi2_initial_enu_t oms::Variable::initialProperty
private

◆ is_state

bool oms::Variable::is_state
private

◆ type

oms_signal_type_enu_t oms::Variable::type
private

◆ vr

fmi2_value_reference_t oms::Variable::vr
private

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