List of all members | Public Member Functions
Plugin Class Reference

A component plugin offering client-side access to to the working memory system by providing a Memory Name System (MNS) client. More...

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

+ Inheritance diagram for Plugin:

Public Member Functions

MemoryNameSystem & getMemoryNameSystemClient ()
 Get the MNS client. More...
 
const MemoryNameSystem & getMemoryNameSystemClient () const
 
std::string getMemoryNameSystemName ()
 Get the name of the MNS component. More...
 
mns::MemoryNameSystemInterfacePrx getMemoryNameSystemProxy ()
 Get the MNS proxy. More...
 
bool isMemoryNameSystemEnabled ()
 Indicate whether the Memory Name System (MNS) is enabled. More...
 
 Plugin (ManagedIceObject &parent, std::string pre)
 
void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void preOnConnectComponent () override
 
void preOnInitComponent () override
 
virtual ~Plugin () override
 
- 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 ()
 

Detailed Description

A component plugin offering client-side access to to the working memory system by providing a Memory Name System (MNS) client.

See also
MemoryNameSystem

Definition at line 19 of file Plugin.h.

Constructor & Destructor Documentation

◆ Plugin()

Plugin ( ManagedIceObject &  parent,
std::string  pre 
)

Definition at line 14 of file Plugin.cpp.

◆ ~Plugin()

~Plugin ( )
overridevirtual

Definition at line 18 of file Plugin.cpp.

Member Function Documentation

◆ getMemoryNameSystemClient() [1/2]

const MemoryNameSystem & getMemoryNameSystemClient ( )

Get the MNS client.

Only valid when enabled.

Definition at line 89 of file Plugin.cpp.

+ Here is the caller graph for this function:

◆ getMemoryNameSystemClient() [2/2]

const MemoryNameSystem& getMemoryNameSystemClient ( ) const

◆ getMemoryNameSystemName()

std::string getMemoryNameSystemName ( )

Get the name of the MNS component.

Definition at line 74 of file Plugin.cpp.

+ Here is the caller graph for this function:

◆ getMemoryNameSystemProxy()

mns::MemoryNameSystemInterfacePrx getMemoryNameSystemProxy ( )

Get the MNS proxy.

Returns
The MNS proxy when MNS is enabled, nullptr when MNS is disabled.

Definition at line 80 of file Plugin.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isMemoryNameSystemEnabled()

bool isMemoryNameSystemEnabled ( )

Indicate whether the Memory Name System (MNS) is enabled.

Definition at line 68 of file Plugin.cpp.

+ Here is the caller graph for this function:

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( armarx::PropertyDefinitionsPtr &  properties)
overridevirtual

Reimplemented from ComponentPlugin.

Definition at line 23 of file Plugin.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 57 of file Plugin.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 43 of file Plugin.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:
The documentation for this class was generated from the following files: