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>

Public Member Functions

 Variable (fmiHandle *fmi4c, int index)
 
 ~Variable ()
 
void markAsState (size_t der_index)
 
void markAsContinuousTimeState (size_t der_index)
 
void markAsContinuousTimeDer ()
 
unsigned int getStateIndex () const
 
bool isParameter () const
 
bool isCalculatedParameter () const
 
bool isInput () const
 
bool isOutput () const
 
bool isLocal () const
 
bool isIndependent () const
 
bool isState () const
 
bool isDer () const
 
bool isContinuousTimeState () const
 
bool isContinuousTimeDer () const
 
bool isExact () const
 
bool isApprox () const
 
bool isCalculated () const
 
bool isInitialUnknown () const
 
const ComRefgetCref () const
 
 operator std::string () const
 
fmi2ValueReference getValueReference () const
 
oms_signal_type_enu_t getType () const
 
const std::string & getDescription () const
 
bool isTypeBoolean () const
 
bool isTypeInteger () const
 
bool isTypeReal () const
 
bool isTypeString () const
 
std::string getCausalityString () const
 
oms_causality_enu_t getCausality () const
 
unsigned int getIndex () const
 
oms::Connector makeConnector (const oms::ComRef &owner) const
 

Private Attributes

ComRef cref
 
std::string description
 
fmi2ValueReference vr
 
fmi2Causality causality
 
fmi2Variability variability
 
fmi2Initial initialProperty
 
bool is_state
 
bool is_der
 
bool is_continuous_time_state
 
bool is_continuous_time_der
 
oms_signal_type_enu_t type
 
unsigned int index
 index origin = 0 More...
 
size_t state_index
 index origin = 0 More...
 
size_t der_index
 index origin = 0 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 ( fmiHandle *  fmi4c,
int  index 
)

◆ ~Variable()

oms::Variable::~Variable ( )

Member Function Documentation

◆ getCausality()

oms_causality_enu_t oms::Variable::getCausality ( ) const

◆ getCausalityString()

std::string oms::Variable::getCausalityString ( ) const

◆ getCref()

const ComRef& oms::Variable::getCref ( ) const
inline

◆ getDescription()

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

◆ getIndex()

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

◆ getStateIndex()

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

◆ getType()

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

◆ getValueReference()

fmi2ValueReference oms::Variable::getValueReference ( ) const
inline

◆ isApprox()

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

◆ isCalculated()

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

◆ isCalculatedParameter()

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

◆ isContinuousTimeDer()

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

◆ isContinuousTimeState()

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

◆ isDer()

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

◆ isExact()

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

◆ isIndependent()

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

◆ isInitialUnknown()

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

◆ isInput()

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

◆ isLocal()

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

◆ isOutput()

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

◆ isParameter()

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

◆ isState()

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

◆ isTypeBoolean()

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

◆ isTypeInteger()

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

◆ isTypeReal()

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

◆ isTypeString()

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

◆ makeConnector()

oms::Connector oms::Variable::makeConnector ( const oms::ComRef owner) const
inline

◆ markAsContinuousTimeDer()

void oms::Variable::markAsContinuousTimeDer ( )
inline

◆ markAsContinuousTimeState()

void oms::Variable::markAsContinuousTimeState ( size_t  der_index)
inline

◆ markAsState()

void oms::Variable::markAsState ( size_t  der_index)
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

fmi2Causality oms::Variable::causality
private

◆ cref

ComRef oms::Variable::cref
private

◆ der_index

size_t oms::Variable::der_index
private

index origin = 0

◆ description

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

◆ index

unsigned int oms::Variable::index
private

index origin = 0

◆ initialProperty

fmi2Initial oms::Variable::initialProperty
private

◆ is_continuous_time_der

bool oms::Variable::is_continuous_time_der
private

◆ is_continuous_time_state

bool oms::Variable::is_continuous_time_state
private

◆ is_der

bool oms::Variable::is_der
private

◆ is_state

bool oms::Variable::is_state
private

◆ state_index

size_t oms::Variable::state_index
private

index origin = 0

◆ type

oms_signal_type_enu_t oms::Variable::type
private

◆ variability

fmi2Variability oms::Variable::variability
private

◆ vr

fmi2ValueReference oms::Variable::vr
private

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