Convenience class for output void (always UpdateMode::push) More...

#include <VoidAccessor.h>

Inheritance diagram for ChimeraTK::VoidOutput:

Collaboration diagram for ChimeraTK::VoidOutput:

Public Member Functions
	VoidOutput (Module *owner, const std::string &name, const std::string &description, const std::unordered_set< std::string > &tags={})

	VoidOutput ()=default

VoidAccessor &	operator= (VoidAccessor &other)=delete

VoidAccessor &	operator= (VoidAccessor &&other) noexcept
	Move assignment.

Public Member Functions inherited from ChimeraTK::VoidAccessor
void	replace (const ChimeraTK::NDRegisterAccessorAbstractor< ChimeraTK::Void > &newAccessor)=delete

VoidAccessor &	operator= (VoidAccessor &other)=delete

	VoidAccessor (VoidAccessor &&other) noexcept
	Move constructor.

VoidAccessor &	operator= (VoidAccessor &&other) noexcept
	Move assignment.

bool	write (ChimeraTK::VersionNumber versionNumber)=delete

bool	writeDestructively (ChimeraTK::VersionNumber versionNumber)=delete

bool	write ()

bool	writeDestructively ()

Public Member Functions inherited from ChimeraTK::InversionOfControlAccessor< VoidAccessor >
	~InversionOfControlAccessor ()
	Unregister at its owner when deleting.

void	setMetaData (const std::optional< std::string > &name, const std::optional< std::string > &unit={}, const std::optional< std::string > &description={}, const std::optional< std::unordered_set< std::string > > &tags={})
	Change meta data (name, unit, description and optionally tags).

void	addTag (const std::string &tag)
	Add a tag.

void	addTags (const std::unordered_set< std::string > &tags)
	Add multiple tags.

const std::unordered_set< std::string > &	getTags ()
	Return set of tags.

	operator VariableNetworkNode ()
	Convert into VariableNetworkNode.

	operator VariableNetworkNode () const

void	replace (VoidAccessor &&other)
	Replace with other accessor.

EntityOwner *	getOwner () const
	Return the owning module.

Model::ProcessVariableProxy	getModel () const

Additional Inherited Members
Protected Member Functions inherited from ChimeraTK::VoidAccessor
	VoidAccessor (Module *owner, const std::string &name, VariableDirection direction, std::string &unit, UpdateMode mode, const std::string &description, const std::unordered_set< std::string > &tags={})

	VoidAccessor (Module *owner, const std::string &name, VariableDirection direction, UpdateMode mode, const std::string &description, const std::unordered_set< std::string > &tags={})

	VoidAccessor ()=default
	Default constructor creates a dysfunctional accessor (to be assigned with a real accessor later)

Protected Member Functions inherited from ChimeraTK::InversionOfControlAccessor< VoidAccessor >
	InversionOfControlAccessor (Module owner, const std::string &name, VariableDirection direction, std::string unit, size_t nElements, UpdateMode mode, const std::string &description, const std::type_info valueType, const std::unordered_set< std::string > &tags={})
	Constructor, only used by child class accessors.

	InversionOfControlAccessor ()=default
	Default constructor creates a dysfunctional accessor (to be assigned with a real accessor later)

std::string	completeDescription (EntityOwner *owner, const std::string &description) const
	complete the description with the full description from the owner

void	registerInModel ()
	Register the variable in the model.

Protected Attributes inherited from ChimeraTK::InversionOfControlAccessor< VoidAccessor >
VariableNetworkNode	_node

Detailed Description

Convenience class for output void (always UpdateMode::push)

Definition at line 68 of file VoidAccessor.h.

Constructor & Destructor Documentation

◆ VoidOutput() [1/2]

ChimeraTK::VoidOutput::VoidOutput	(	Module *	owner,
		const std::string &	name,
		const std::string &	description,
		const std::unordered_set< std::string > &	tags = `{}`
	)

inline

Definition at line 69 of file VoidAccessor.h.

◆ VoidOutput() [2/2]

ChimeraTK::VoidOutput::VoidOutput ( )

default

Member Function Documentation

◆ operator=() [1/2]

VoidAccessor & ChimeraTK::VoidAccessor::operator= ( VoidAccessor && other )

inlinenoexcept

Move assignment.

Definition at line 30 of file VoidAccessor.h.

◆ operator=() [2/2]

VoidAccessor & ChimeraTK::VoidAccessor::operator= ( VoidAccessor & other )

delete

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

/scratch/dragon/sources/ChimeraTK-ApplicationCore/include/VoidAccessor.h

Public Member Functions