PyInterfaceVillas Class Reference

Inheritance diagram for PyInterfaceVillas:

Collaboration diagram for PyInterfaceVillas:

Public Member Functions
	PyInterfaceVillas (py::dict config, CPS::UInt queueLength, CPS::UInt sampleLength, const CPS::String &name, CPS::UInt downsampling)
	InterfaceVillas (const String &nodeConfig, UInt queueLength=512, UInt sampleLength=64, const String &name="", UInt downsampling=1, spdlog::level::level_enum logLevel=spdlog::level::level_enum::info)
	create a new InterfaceVillas instance
Public Member Functions inherited from DPsim::InterfaceVillas
	InterfaceVillas (const String &nodeConfig, UInt queueLength=512, UInt sampleLength=64, const String &name="", UInt downsampling=1, spdlog::level::level_enum logLevel=spdlog::level::level_enum::info)
	create a new InterfaceVillas instance
virtual void	importAttribute (CPS::AttributeBase::Ptr attr, UInt idx, Bool blockOnRead=false, Bool syncOnSimulationStart=true, const String &name="", const String &unit="")
	configure an attribute import
virtual void	exportAttribute (CPS::AttributeBase::Ptr attr, UInt idx, Bool waitForOnWrite, const String &name="", const String &unit="")
	configure an attribute export
virtual void	printVillasSignals () const
Public Member Functions inherited from DPsim::InterfaceQueued
	InterfaceQueued (std::shared_ptr< InterfaceWorker > intf, const String &name="", UInt downsampling=1)
virtual void	open () override
virtual void	close () override
virtual void	pushDpsimAttrsToQueue ()
virtual void	popDpsimAttrsFromQueue (bool isSync=false)
virtual void	syncExports () override
virtual void	syncImports () override
	Function called by the Simulation to perform interface synchronization.
virtual CPS::Task::List	getTasks () override
virtual void	setLogger (CPS::Logger::Log log) override
Public Member Functions inherited from DPsim::Interface
	Interface (const String &name="", spdlog::level::level_enum logLevel=spdlog::level::level_enum::info)
virtual String &	getName ()
virtual void	addImport (CPS::AttributeBase::Ptr attr, bool blockOnRead=false, bool syncOnSimulationStart=true)
virtual void	addExport (CPS::AttributeBase::Ptr attr)

Additional Inherited Members
Public Types inherited from DPsim::InterfaceQueued
enum	AttributePacketFlags { PACKET_NO_FLAGS = 0 , PACKET_CLOSE_INTERFACE = 1 }
typedef std::shared_ptr< InterfaceQueued >	Ptr
using	AttributePacket
Public Types inherited from DPsim::Interface
typedef std::shared_ptr< Interface >	Ptr
Static Public Member Functions inherited from SharedFactory< Interface >
static std::shared_ptr< Interface >	make (Args &&...args)
Static Public Member Functions inherited from SharedFactory< InterfaceQueued >
static std::shared_ptr< InterfaceQueued >	make (Args &&...args)
Static Public Member Functions inherited from SharedFactory< InterfaceVillas >
static std::shared_ptr< InterfaceVillas >	make (Args &&...args)
Public Attributes inherited from DPsim::Interface
std::vector< std::tuple< CPS::AttributeBase::Ptr, UInt, bool, bool > >	mImportAttrsDpsim
std::vector< std::tuple< CPS::AttributeBase::Ptr, UInt > >	mExportAttrsDpsim
Protected Attributes inherited from DPsim::InterfaceQueued
std::shared_ptr< InterfaceWorker >	mInterfaceWorker
UInt	mDownsampling
std::thread	mInterfaceWriterThread
std::thread	mInterfaceReaderThread
std::shared_ptr< moodycamel::BlockingReaderWriterQueue< AttributePacket > >	mQueueDpsimToInterface
std::shared_ptr< moodycamel::BlockingReaderWriterQueue< AttributePacket > >	mQueueInterfaceToDpsim
Protected Attributes inherited from DPsim::Interface
CPS::Logger::Log	mLog
String	mName
bool	mSyncOnSimulationStart
UInt	mCurrentSequenceDpsimToInterface = 1
UInt	mNextSequenceInterfaceToDpsim = 1
std::atomic< bool >	mOpened

Detailed Description

Definition at line 15 of file pybind-dpsim-villas.cpp.

Constructor & Destructor Documentation

PyInterfaceVillas()

PyInterfaceVillas::PyInterfaceVillas ( py::dict config, CPS::UInt queueLength, CPS::UInt sampleLength, const CPS::String & name, CPS::UInt downsampling )

inline

Definition at line 20 of file pybind-dpsim-villas.cpp.

Member Function Documentation

InterfaceVillas()

DPsim::InterfaceVillas::InterfaceVillas	(	const String &	nodeConfig,
		UInt	queueLength = 512,
		UInt	sampleLength = 64,
		const String &	name = "",
		UInt	downsampling = 1,
		spdlog::level::level_enum	logLevel = spdlog::level::level_enum::info )

create a new InterfaceVillas instance

Parameters

nodeConfig	VILLASnode node configuration in JSON format
queueLength	queue lenght configured for the node
sampleLength	sample length configured for the node
name	Name of this interface. Currently only used for naming the simulation tasks
downsampling	Only import and export attributes on every nth timestep

Definition at line 31 of file InterfaceVillas.cpp.

---

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

• /__w/dpsim/dpsim/dpsim-villas/src/pybind-dpsim-villas.cpp