DPsim::DataLoggerInterface Class Reference

#include <DataLoggerInterface.h>

Inheritance diagram for DPsim::DataLoggerInterface:

Public Types
typedef std::shared_ptr< DataLoggerInterface >	Ptr
typedef std::vector< DataLoggerInterface::Ptr >	List

Public Member Functions
	DataLoggerInterface ()
virtual	~DataLoggerInterface ()=default
virtual void	start ()=0
virtual void	stop ()=0
virtual void	logAttribute (const String &name, CPS::AttributeBase::Ptr attr, UInt rowsMax=0, UInt colsMax=0)
void	logAttribute (const std::vector< String > &name, CPS::AttributeBase::Ptr attr)
virtual void	log (Real time, Int timeStepCount)=0
virtual CPS::Task::Ptr	getTask ()=0

Protected Attributes
std::map< String, CPS::AttributeBase::Ptr >	mAttributes

Detailed Description

Definition at line 21 of file DataLoggerInterface.h.

Member Typedef Documentation

List

typedef std::vector<DataLoggerInterface::Ptr> DPsim::DataLoggerInterface::List

Definition at line 27 of file DataLoggerInterface.h.

Ptr

typedef std::shared_ptr<DataLoggerInterface> DPsim::DataLoggerInterface::Ptr

Definition at line 26 of file DataLoggerInterface.h.

Constructor & Destructor Documentation

DataLoggerInterface()

DPsim::DataLoggerInterface::DataLoggerInterface ( )

inline

Definition at line 29 of file DataLoggerInterface.h.

~DataLoggerInterface()

virtual DPsim::DataLoggerInterface::~DataLoggerInterface ( )

virtualdefault

Member Function Documentation

getTask()

virtual CPS::Task::Ptr DPsim::DataLoggerInterface::getTask ( )

pure virtual

Implemented in DPsim::DataLogger, and DPsim::RealTimeDataLogger.

log()

virtual void DPsim::DataLoggerInterface::log ( Real time, Int timeStepCount )

pure virtual

Implemented in DPsim::DataLogger, and DPsim::RealTimeDataLogger.

logAttribute() [1/2]

void DPsim::DataLoggerInterface::logAttribute ( const std::vector< String > & name, CPS::AttributeBase::Ptr attr )

inline

DEPRECATED: Only use for compatiblity, otherwise this just adds extra overhead to the logger. Instead just call logAttribute multiple times for every coefficient using attr->deriveCoeff<>(a,b).

Definition at line 117 of file DataLoggerInterface.h.

logAttribute() [2/2]

virtual void DPsim::DataLoggerInterface::logAttribute ( const String & name, CPS::AttributeBase::Ptr attr, UInt rowsMax = 0, UInt colsMax = 0 )

inlinevirtual

Definition at line 38 of file DataLoggerInterface.h.

start()

virtual void DPsim::DataLoggerInterface::start ( )

pure virtual

Implemented in DPsim::DataLogger, and DPsim::RealTimeDataLogger.

stop()

virtual void DPsim::DataLoggerInterface::stop ( )

pure virtual

Implemented in DPsim::DataLogger, and DPsim::RealTimeDataLogger.

Member Data Documentation

mAttributes

std::map<String, CPS::AttributeBase::Ptr> DPsim::DataLoggerInterface::mAttributes

protected

Definition at line 23 of file DataLoggerInterface.h.

---

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

• /__w/dpsim/dpsim/dpsim/include/dpsim/DataLoggerInterface.h