dds-fmu 0.5.1
DDS-FMU communication integration
Public Member Functions | List of all members
ddsfmu::FmuInstance Class Reference

Co-simulation slave instance for dds-fmu. More...

#include <FmuInstance.hpp>

+ Inheritance diagram for ddsfmu::FmuInstance:

Public Member Functions

 FmuInstance (const std::string &name, const std::filesystem::path &resource_path, cppfmu::Logger logger)
 
void SetReal (const cppfmu::FMIValueReference vr[], std::size_t nvr, const cppfmu::FMIReal value[]) override
 
void GetReal (const cppfmu::FMIValueReference vr[], std::size_t nvr, cppfmu::FMIReal value[]) const override
 
void SetInteger (const cppfmu::FMIValueReference vr[], std::size_t nvr, const cppfmu::FMIInteger value[]) override
 
void GetInteger (const cppfmu::FMIValueReference vr[], std::size_t nvr, cppfmu::FMIInteger value[]) const override
 
void SetBoolean (const cppfmu::FMIValueReference vr[], std::size_t nvr, const cppfmu::FMIBoolean value[]) override
 
void GetBoolean (const cppfmu::FMIValueReference vr[], std::size_t nvr, cppfmu::FMIBoolean value[]) const override
 
void SetString (const cppfmu::FMIValueReference vr[], std::size_t nvr, const cppfmu::FMIString value[]) override
 
void GetString (const cppfmu::FMIValueReference vr[], std::size_t nvr, cppfmu::FMIString value[]) const override
 
virtual void ExitInitializationMode () override
 
 ~FmuInstance ()=default
 
void SetupExperiment (cppfmu::FMIBoolean, cppfmu::FMIReal, cppfmu::FMIReal tStart, cppfmu::FMIBoolean, cppfmu::FMIReal) override
 
bool DoStep (cppfmu::FMIReal currentCommunicationPoint, cppfmu::FMIReal communicationStepSize, cppfmu::FMIBoolean, cppfmu::FMIReal &) override
 
void Reset () override
 

Detailed Description

An instance of this class maps directly to C functions defined in the FMI standard.

It holds members of classes DataMapper and DynamicPubSub, which together ensure mapping of signals between FMI and DDS.

Constructor & Destructor Documentation

◆ FmuInstance()

ddsfmu::FmuInstance::FmuInstance ( const std::string &  name,
const std::filesystem::path &  resource_path,
cppfmu::Logger  logger 
)
inline

◆ ~FmuInstance()

ddsfmu::FmuInstance::~FmuInstance ( )
default

Member Function Documentation

◆ DoStep()

bool ddsfmu::FmuInstance::DoStep ( cppfmu::FMIReal  currentCommunicationPoint,
cppfmu::FMIReal  communicationStepSize,
cppfmu::FMIBoolean  ,
cppfmu::FMIReal &   
)
inlineoverride

◆ ExitInitializationMode()

virtual void ddsfmu::FmuInstance::ExitInitializationMode ( )
inlineoverridevirtual

◆ GetBoolean()

void ddsfmu::FmuInstance::GetBoolean ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
cppfmu::FMIBoolean  value[] 
) const
inlineoverride

◆ GetInteger()

void ddsfmu::FmuInstance::GetInteger ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
cppfmu::FMIInteger  value[] 
) const
inlineoverride

◆ GetReal()

void ddsfmu::FmuInstance::GetReal ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
cppfmu::FMIReal  value[] 
) const
inlineoverride

◆ GetString()

void ddsfmu::FmuInstance::GetString ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
cppfmu::FMIString  value[] 
) const
inlineoverride

◆ Reset()

void ddsfmu::FmuInstance::Reset ( )
inlineoverride

◆ SetBoolean()

void ddsfmu::FmuInstance::SetBoolean ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
const cppfmu::FMIBoolean  value[] 
)
inlineoverride

◆ SetInteger()

void ddsfmu::FmuInstance::SetInteger ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
const cppfmu::FMIInteger  value[] 
)
inlineoverride

◆ SetReal()

void ddsfmu::FmuInstance::SetReal ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
const cppfmu::FMIReal  value[] 
)
inlineoverride

◆ SetString()

void ddsfmu::FmuInstance::SetString ( const cppfmu::FMIValueReference  vr[],
std::size_t  nvr,
const cppfmu::FMIString  value[] 
)
inlineoverride

◆ SetupExperiment()

void ddsfmu::FmuInstance::SetupExperiment ( cppfmu::FMIBoolean  ,
cppfmu::FMIReal  ,
cppfmu::FMIReal  tStart,
cppfmu::FMIBoolean  ,
cppfmu::FMIReal   
)
inlineoverride