ChimeraTK::ScalarOutput< UserType > Struct Template Reference

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

#include <ScalarAccessor.h>

Inheritance diagram for ChimeraTK::ScalarOutput< UserType >:

Collaboration diagram for ChimeraTK::ScalarOutput< UserType >:

Public Member Functions
	ScalarOutput (Module *owner, const std::string &name, std::string unit, const std::string &description, const std::unordered_set< std::string > &tags={})
	ScalarOutput ()
Public Member Functions inherited from ChimeraTK::ScalarAccessor< UserType >
void	replace (const ChimeraTK::NDRegisterAccessorAbstractor< UserType > &newAccessor)=delete
ScalarAccessor< UserType > &	operator= (ScalarAccessor< UserType > &other)=delete
	ScalarAccessor (ScalarAccessor< UserType > &&other) noexcept
	Move constructor. More...
ScalarAccessor< UserType > &	operator= (ScalarAccessor< UserType > &&other) noexcept
	Move assignment. More...
bool	write (ChimeraTK::VersionNumber versionNumber)=delete
bool	writeDestructively (ChimeraTK::VersionNumber versionNumber)=delete
void	writeIfDifferent (UserType newValue, VersionNumber versionNumber, DataValidity validity)=delete
void	setAndWrite (UserType newValue, VersionNumber versionNumber)=delete
bool	write ()
bool	writeDestructively ()
void	writeIfDifferent (UserType newValue)
void	setAndWrite (UserType newValue)
Public Member Functions inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
	~InversionOfControlAccessor ()
	Unregister at its owner when deleting. More...
void	setMetaData (const std::string &name, const std::string &unit, const std::string &description)
	Change meta data (name, unit, description and optionally tags). More...
void	setMetaData (const std::string &name, const std::string &unit, const std::string &description, const std::unordered_set< std::string > &tags)
void	addTag (const std::string &tag)
	Add a tag. More...
void	addTags (const std::unordered_set< std::string > &tags)
	Add multiple tags. More...
const std::unordered_set< std::string > &	getTags ()
	Return set of tags. More...
	operator VariableNetworkNode ()
	Convert into VariableNetworkNode. More...
	operator VariableNetworkNode () const
void	replace (ScalarAccessor< UserType > &&other)
	Replace with other accessor. More...
EntityOwner *	getOwner () const
	Return the owning module. More...
Model::ProcessVariableProxy	getModel () const

Additional Inherited Members
Public Types inherited from ChimeraTK::ScalarAccessor< UserType >
using	value_type = UserType
Protected Member Functions inherited from ChimeraTK::ScalarAccessor< UserType >
	ScalarAccessor (Module *owner, const std::string &name, VariableDirection direction, std::string unit, UpdateMode mode, const std::string &description, const std::unordered_set< std::string > &tags={})
	ScalarAccessor ()=default
	Default constructor creates a dysfunctional accessor (to be assigned with a real accessor later) More...
Protected Member Functions inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
std::string	completeDescription (EntityOwner *owner, const std::string &description) const
	complete the description with the full description from the owner More...
	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={})
	InversionOfControlAccessor ()=default
	Default constructor creates a dysfunctional accessor (to be assigned with a real accessor later) More...
Protected Attributes inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
VariableNetworkNode	_node

Detailed Description

template<typename UserType>
struct ChimeraTK::ScalarOutput< UserType >

Convenience class for output scalar accessors (always UpdateMode::push)

Definition at line 92 of file ScalarAccessor.h.

Constructor & Destructor Documentation

ScalarOutput() [1/2]

template<typename UserType >

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

Definition at line 226 of file ScalarAccessor.h.

ScalarOutput() [2/2]

template<typename UserType >

ChimeraTK::ScalarOutput< UserType >::ScalarOutput ( )

inline

Definition at line 95 of file ScalarAccessor.h.

---

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

• /scratch/dragon/sources/ChimeraTK-ApplicationCore/include/ScalarAccessor.h