OMSimulatorLib
The OMSimulator project is a FMI-based co-simulation environment.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
oms::ComponentDCP Class Reference

#include <ComponentDCP.h>

Inheritance diagram for oms::ComponentDCP:
[legend]
Collaboration diagram for oms::ComponentDCP:
[legend]

Public Member Functions

 ~ComponentDCP ()
 
const DCPInfo * getDCPInfo () const
 
oms_status_enu_t addSignalsToResults (const char *regex)
 
oms_status_enu_t exportToSSD (pugi::xml_node &node, Snapshot &snapshot, std::string variantName) const
 
oms_status_enu_t initialize ()
 
oms_status_enu_t instantiate ()
 
oms_status_enu_t stepUntil (double stopTime)
 
oms_status_enu_t registerSignalsForResultFile (ResultWriter &resultFile)
 
oms_status_enu_t removeSignalsFromResults (const char *regex)
 
oms_status_enu_t reset ()
 
oms_status_enu_t terminate ()
 
oms_status_enu_t updateSignals (ResultWriter &resultWriter)
 
Variable * getVariable (const ComRef &cref)
 
void getFilteredSignals (std::vector< Connector > &filteredSignals) const
 
oms_status_enu_t initializeDependencyGraph_outputs ()
 
- Public Member Functions inherited from oms::Component
virtual ~Component ()
 
virtual oms_status_enu_t exportToSSV (pugi::xml_node &ssvNode)
 
virtual void getFilteredUnitDefinitionsToSSD (std::map< std::string, std::map< std::string, std::string > > &unitDefinitions)
 
virtual void getFilteredEnumerationDefinitionsToSSD (std::map< std::string, std::map< std::string, std::string > > &enumerationDefinitions)
 
virtual oms_status_enu_t getVariableType (const ComRef &cref, oms_signal_type_enu_t &type)
 
virtual bool getCanGetAndSetState ()
 
virtual const FMUInfo * getFMUInfo () const
 
virtual oms_status_enu_t deleteStartValue (const ComRef &cref)
 
virtual std::vector< Values > getValuesResources ()
 
virtual Values & getValues ()
 
virtual oms_status_enu_t setValuesResources (Values &values)
 
virtual oms_status_enu_t updateOrDeleteStartValueInReplacedComponent (std::vector< std::string > &warningList)
 
virtual oms_status_enu_t exportToSSMTemplate (pugi::xml_node &ssmNode)
 
virtual oms_status_enu_t exportToSSVTemplate (pugi::xml_node &ssvNode, Snapshot &snapshot)
 
virtual oms_status_enu_t freeState ()
 
virtual oms_status_enu_t getBoolean (const ComRef &cref, bool &value)
 
virtual oms_status_enu_t getInteger (const ComRef &cref, int &value)
 
virtual oms_status_enu_t getReal (const ComRef &cref, double &value)
 
virtual oms_status_enu_t getString (const ComRef &cref, std::string &value)
 
virtual oms_status_enu_t getRealOutputDerivative (const ComRef &cref, SignalDerivative &der)
 
virtual oms_status_enu_t getDirectionalDerivative (const ComRef &unknownCref, const ComRef &knownCref, double &value)
 
virtual oms_status_enu_t restoreState ()
 
virtual oms_status_enu_t saveState ()
 
virtual oms_status_enu_t setBoolean (const ComRef &cref, bool value)
 
virtual oms_status_enu_t setInteger (const ComRef &cref, int value)
 
virtual oms_status_enu_t setReal (const ComRef &cref, double value)
 
virtual oms_status_enu_t setString (const ComRef &cref, const std::string &value)
 
virtual oms_status_enu_t setUnit (const ComRef &cref, const std::string &value)
 
virtual oms_status_enu_t setRealInputDerivative (const ComRef &cref, const SignalDerivative &der)
 
virtual oms_status_enu_t setTime (double time)
 
virtual oms_status_enu_t setExportName (const std::string &exportName)
 
virtual oms_status_enu_t newResources (const std::string &ssvFileName, const std::string &ssmFileName, bool externalResources)
 
virtual oms_status_enu_t addResources (std::string &filename)
 
virtual oms_status_enu_t deleteReferencesInSSD (const std::string &filename)
 
virtual oms_status_enu_t deleteResourcesInSSP (const std::string &filename)
 
virtual size_t getNumberOfContinuousStates () const
 
virtual size_t getNumberOfEventIndicators () const
 
virtual oms_status_enu_t getContinuousStates (double *states)
 
virtual oms_status_enu_t setContinuousStates (double *states)
 
virtual oms_status_enu_t getDerivatives (double *derivatives)
 
virtual oms_status_enu_t getNominalsOfContinuousStates (double *nominals)
 
virtual oms_status_enu_t getEventindicators (double *eventindicators)
 
virtual oms_status_enu_t getEventindicators (double *eventindicators, size_t size)
 
virtual fmuHandle * getFMU ()
 
virtual fmi2EventInfo * getEventInfo ()
 
virtual oms_status_enu_t doEventIteration ()
 
virtual oms_status_enu_t completedIntegratorStep (bool noSetFMUStatePriorToCurrentPoint, bool &enterEventMode, bool &terminateSimulation)
 
virtual oms_status_enu_t enterEventMode ()
 
virtual oms_status_enu_t enterContinuousTimeMode ()
 
virtual bool getNewDiscreteStatesNeeded ()
 
virtual bool getTerminateSimulation ()
 
virtual bool getNominalsOfContinuousStatesChanged ()
 
virtual bool getValuesOfContinuousStatesChanged ()
 
virtual bool getNextEventTimeDefined ()
 
virtual double getNextEventTime ()
 
const ComRef & getCref () const
 
ComRef getFullCref () const
 
Element * getElement ()
 
Connector * getConnector (const ComRef &cref)
 
Connector ** getConnectors ()
 
oms_status_enu_t deleteConnector (const ComRef &cref)
 
void getAllResources (std::vector< std::string > &resources) const
 
const std::string & getPath () const
 
const std::string & getTempDir () const
 
void setPath (const std::string &newPath)
 
void setTempDir (const std::string &tempDir)
 
oms_component_enu_t getType () const
 
System * getParentSystem () const
 
Model & getModel () const
 
void setGeometry (const ssd::ElementGeometry &geometry)
 
const DirectedGraph & getInitialUnknownsGraph ()
 
const DirectedGraph & getOutputsGraph ()
 
oms_status_enu_t rename (const ComRef &newCref)
 rename submodules, e.g., fmu:s
 

Static Public Member Functions

static Component * NewComponent (const ComRef &cref, System *parentSystem, const std::string &dcpPath, std::string replaceComponent="")
 
static Component * NewComponent (const pugi::xml_node &node, System *parentSystem, const std::string &sspVersion, const Snapshot &snapshot, std::string variantName)
 

Protected Member Functions

 ComponentDCP (const ComRef &cref, System *parentSystem, const std::string &fmuPath)
 
 ComponentDCP (ComponentDCP const &copy)
 not implemented
 
ComponentDCP & operator= (ComponentDCP const &copy)
 not implemented
 
- Protected Member Functions inherited from oms::Component
 Component (const ComRef &cref, oms_component_enu_t type, System *parentSystem, const std::string &path)
 
 Component (Component const &)
 not implemented
 
Component & operator= (Component const &)
 not implemented
 
virtual oms_status_enu_t renameValues (const ComRef &oldCref, const ComRef &newCref)
 

Private Member Functions

oms::ComRef getValidCref (ComRef cref)
 

Private Attributes

DCPInfo dcpInfo
 
std::shared_ptr< SlaveDescription_t > dcpSlaveDescription
 
std::vector< Variable > allVariables
 
std::vector< unsigned int > calculatedParameters
 
std::vector< unsigned int > derivatives
 
std::vector< unsigned int > inputs
 
std::vector< unsigned int > outputs
 
std::vector< unsigned int > parameters
 
std::vector< bool > exportVariables
 
Values values
 start values defined before instantiating the FMU and external inputs defined after initialization
 
double time
 

Additional Inherited Members

- Protected Attributes inherited from oms::Component
DirectedGraph initialUnknownsGraph
 
DirectedGraph outputsGraph
 
Element element
 
std::vector< Connector * > connectors
 
Clock clock
 
unsigned int clock_id
 

Constructor & Destructor Documentation

◆ ~ComponentDCP()

oms::ComponentDCP::~ComponentDCP ( )

◆ ComponentDCP() [1/2]

oms::ComponentDCP::ComponentDCP ( const ComRef &  cref,
System *  parentSystem,
const std::string &  fmuPath 
)
protected

◆ ComponentDCP() [2/2]

oms::ComponentDCP::ComponentDCP ( ComponentDCP const &  copy)
protected

not implemented

Member Function Documentation

◆ addSignalsToResults()

oms_status_enu_t oms::ComponentDCP::addSignalsToResults ( const char *  regex)
virtual

Implements oms::Component.

◆ exportToSSD()

oms_status_enu_t oms::ComponentDCP::exportToSSD ( pugi::xml_node &  node,
Snapshot &  snapshot,
std::string  variantName 
) const
virtual

Implements oms::Component.

◆ getDCPInfo()

const DCPInfo * oms::ComponentDCP::getDCPInfo ( ) const
inline

◆ getFilteredSignals()

void oms::ComponentDCP::getFilteredSignals ( std::vector< Connector > &  filteredSignals) const
virtual

Implements oms::Component.

◆ getValidCref()

oms::ComRef oms::ComponentDCP::getValidCref ( ComRef  cref)
private

◆ getVariable()

oms::Variable * oms::ComponentDCP::getVariable ( const ComRef &  cref)
virtual

Implements oms::Component.

◆ initialize()

oms_status_enu_t oms::ComponentDCP::initialize ( )
virtual

Implements oms::Component.

◆ initializeDependencyGraph_outputs()

oms_status_enu_t oms::ComponentDCP::initializeDependencyGraph_outputs ( )
Here is the call graph for this function:

◆ instantiate()

oms_status_enu_t oms::ComponentDCP::instantiate ( )
virtual

Implements oms::Component.

◆ NewComponent() [1/2]

oms::Component * oms::ComponentDCP::NewComponent ( const ComRef &  cref,
oms::System *  parentSystem,
const std::string &  dcpPath,
std::string  replaceComponent = "" 
)
static
Here is the call graph for this function:
Here is the caller graph for this function:

◆ NewComponent() [2/2]

oms::Component * oms::ComponentDCP::NewComponent ( const pugi::xml_node &  node,
oms::System *  parentSystem,
const std::string &  sspVersion,
const Snapshot &  snapshot,
std::string  variantName 
)
static
Here is the call graph for this function:

◆ operator=()

ComponentDCP & oms::ComponentDCP::operator= ( ComponentDCP const &  copy)
protected

not implemented

◆ registerSignalsForResultFile()

oms_status_enu_t oms::ComponentDCP::registerSignalsForResultFile ( ResultWriter &  resultFile)
virtual

Implements oms::Component.

◆ removeSignalsFromResults()

oms_status_enu_t oms::ComponentDCP::removeSignalsFromResults ( const char *  regex)
virtual

Implements oms::Component.

◆ reset()

oms_status_enu_t oms::ComponentDCP::reset ( )
virtual

Implements oms::Component.

◆ stepUntil()

oms_status_enu_t oms::ComponentDCP::stepUntil ( double  stopTime)
inlinevirtual

Reimplemented from oms::Component.

◆ terminate()

oms_status_enu_t oms::ComponentDCP::terminate ( )
virtual

Implements oms::Component.

◆ updateSignals()

oms_status_enu_t oms::ComponentDCP::updateSignals ( ResultWriter &  resultWriter)
virtual

Implements oms::Component.

Member Data Documentation

◆ allVariables

std::vector<Variable> oms::ComponentDCP::allVariables
private

◆ calculatedParameters

std::vector<unsigned int> oms::ComponentDCP::calculatedParameters
private

◆ dcpInfo

DCPInfo oms::ComponentDCP::dcpInfo
private

◆ dcpSlaveDescription

std::shared_ptr<SlaveDescription_t> oms::ComponentDCP::dcpSlaveDescription
private

◆ derivatives

std::vector<unsigned int> oms::ComponentDCP::derivatives
private

◆ exportVariables

std::vector<bool> oms::ComponentDCP::exportVariables
private

◆ inputs

std::vector<unsigned int> oms::ComponentDCP::inputs
private

◆ outputs

std::vector<unsigned int> oms::ComponentDCP::outputs
private

◆ parameters

std::vector<unsigned int> oms::ComponentDCP::parameters
private

◆ time

double oms::ComponentDCP::time
private

◆ values

Values oms::ComponentDCP::values
private

start values defined before instantiating the FMU and external inputs defined after initialization


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