ChimeraTK-ApplicationCore  04.01.00
ChimeraTK::VoidInput Struct Reference

Convenience class for input accessors. More...

#include <VoidAccessor.h>

+ Inheritance diagram for ChimeraTK::VoidInput:
+ Collaboration diagram for ChimeraTK::VoidInput:

Public Member Functions

 VoidInput (Module *owner, const std::string &name, const std::string &description, const std::unordered_set< std::string > &tags={})
 
 VoidInput ()=default
 
VoidAccessoroperator= (VoidAccessor &other)=delete
 
VoidAccessoroperator= (VoidAccessor &&other) noexcept
 Move assignment. More...
 
- Public Member Functions inherited from ChimeraTK::VoidAccessor
void replace (const ChimeraTK::NDRegisterAccessorAbstractor< ChimeraTK::Void > &newAccessor)=delete
 
VoidAccessoroperator= (VoidAccessor &other)=delete
 
 VoidAccessor (VoidAccessor &&other) noexcept
 Move constructor. More...
 
VoidAccessoroperator= (VoidAccessor &&other) noexcept
 Move assignment. More...
 
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. 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 (VoidAccessor &&other)
 Replace with other accessor. More...
 
EntityOwnergetOwner () const
 Return the owning module. More...
 
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) More...
 
- Protected Member Functions inherited from ChimeraTK::InversionOfControlAccessor< VoidAccessor >
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< VoidAccessor >
VariableNetworkNode _node
 

Detailed Description

Convenience class for input accessors.

For Void there is only UpdateMode::push

Definition at line 56 of file VoidAccessor.h.

Constructor & Destructor Documentation

◆ VoidInput() [1/2]

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

Definition at line 57 of file VoidAccessor.h.

◆ VoidInput() [2/2]

ChimeraTK::VoidInput::VoidInput ( )
default

Member Function Documentation

◆ operator=() [1/2]

VoidAccessor & ChimeraTK::VoidAccessor::operator=
inlinenoexcept

Move assignment.

Definition at line 95 of file VoidAccessor.h.

◆ operator=() [2/2]

VoidAccessor& ChimeraTK::VoidAccessor::operator=
delete

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