List of all members | Public Member Functions
ReaderWriterPlugin< T > Class Template Reference

A component plugin offering client-side access to a reader or writer and manages the lifecycle, e.g. More...

#include <RobotAPI/libraries/armem/client/plugins/ReaderWriterPlugin.h>

+ Inheritance diagram for ReaderWriterPlugin< T >:

Public Member Functions

T & get ()
 
const T & get () const
 
bool isAvailable () const
 
void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void preOnConnectComponent () override
 
 ReaderWriterPlugin (ManagedIceObject &parent, const std::string &pre)
 
 ~ReaderWriterPlugin () override=default
 
- Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObject & parent ()
 
template<class T >
T & parent ()
 
const ManagedIceObject & parent () const
 
template<class T >
const T & parent () const
 
template<class T >
bool parentDerives () const
 
virtual ~ManagedIceObjectPlugin ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from ComponentPlugin
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
- Protected Member Functions inherited from ManagedIceObjectPlugin
template<class PluginT , class... ParamsT>
PluginT * addPlugin (const std::string prefix="", ParamsT &&...params)
 
template<class PluginT , class... ParamsT>
void addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&...params)
 
template<class PluginT , class... ParamsT>
void addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&...params)
 
void addPluginDependency (ManagedIceObjectPlugin *dependedOn)
 
void addPluginDependency (std::experimental::observer_ptr< ManagedIceObjectPlugin > dependedOn)
 
std::string makePropertyName (const std::string &name)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
virtual void postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
const std::string & prefix () const
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 
virtual void preOnInitComponent ()
 

Detailed Description

template<typename T>
class armarx::armem::client::plugins::ReaderWriterPlugin< T >

A component plugin offering client-side access to a reader or writer and manages the lifecycle, e.g.

connecting to the memory. Access to the working memory system is provided by a Memory Name System (MNS) client.

See also
MemoryNameSystem

Definition at line 44 of file ReaderWriterPlugin.h.

Constructor & Destructor Documentation

◆ ReaderWriterPlugin()

ReaderWriterPlugin ( ManagedIceObject &  parent,
const std::string &  pre 
)
inline

Definition at line 47 of file ReaderWriterPlugin.h.

◆ ~ReaderWriterPlugin()

~ReaderWriterPlugin ( )
overridedefault

Member Function Documentation

◆ get() [1/2]

T& get ( )
inline

Definition at line 87 of file ReaderWriterPlugin.h.

+ Here is the caller graph for this function:

◆ get() [2/2]

const T& get ( ) const
inline

Definition at line 95 of file ReaderWriterPlugin.h.

◆ isAvailable()

bool isAvailable ( ) const
inline

Definition at line 80 of file ReaderWriterPlugin.h.

+ Here is the caller graph for this function:

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr &  properties)
inlineoverridevirtual

Reimplemented from ComponentPlugin.

Definition at line 60 of file ReaderWriterPlugin.h.

◆ preOnConnectComponent()

void preOnConnectComponent ( )
inlineoverridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 66 of file ReaderWriterPlugin.h.

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