ChimeraTK::ScalarOutput< UserType > Class 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.
ScalarAccessor< UserType > &	operator= (ScalarAccessor< UserType > &&other) noexcept
	Move assignment.
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)
	~ScalarAccessor ()
Public Member Functions inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
virtual	~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 (ScalarAccessor< UserType > &&other)
	Replace with other accessor.
EntityOwner *	getOwner () const
	Return the owning module.
Model::ProcessVariableProxy	getModel () const
bool	checkMetadataWriteDifference ()
	Checks whether a writeIfDifferent would have to issue a write, even if the payload data is unchanged.

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)
Protected Member Functions inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
	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.
void	init ()
	Late initialisation of stuff we cannot do in our constructor.
void	deinit ()
	Early deinitialisation of stuff we cannot do in our destructor.
Protected Attributes inherited from ChimeraTK::InversionOfControlAccessor< ScalarAccessor< UserType > >
VariableNetworkNode	_node

Detailed Description

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

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

Examples

demoStatusMonitor.cc.

Definition at line 97 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 234 of file ScalarAccessor.h.

ScalarOutput() [2/2]

template<typename UserType >

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

inline

Definition at line 101 of file ScalarAccessor.h.

---

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

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