Plugin Class Reference

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

+ Inheritance diagram for Plugin:

Public Member Functions

 Plugin (ManagedIceObject &parent, std::string prefix)
 
virtual void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
virtual void postOnConnectComponent () override
 
virtual void postOnInitComponent () override
 
virtual void preOnDisconnectComponent () override
 
virtual void preOnInitComponent () override
 
void setMemoryName (const std::string &memoryName)
 Set the name of the wm and the ltm. More...
 
virtual ~Plugin () override
 
- Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObjectparent ()
 
template<class T >
Tparent ()
 
const ManagedIceObjectparent () const
 
template<class T >
const Tparent () const
 
template<class T >
bool parentDerives () const
 
virtual ~ManagedIceObjectPlugin ()=default
 

Public Attributes

MemoryToIceAdapter iceAdapter {&workingMemory, &longtermMemory}
 Helps connecting memory to ice. Used to handle Ice callbacks. More...
 
server::ltm::Memory longtermMemory
 A manager class for the ltm. It internally holds a normal wm instance as a cache. More...
 
client::MemoryListenerInterfacePrx memoryTopic
 Available after onConnect(). More...
 
std::string memoryTopicName
 Available at onInit(). More...
 
server::wm::Memory workingMemory
 The actual memory. More...
 

Protected Member Functions

mns::dto::RegisterServerResult registerServer (armarx::Component &parent)
 Register the parent component in the MNS. More...
 
mns::dto::RemoveServerResult removeServer ()
 Remove the parent component from the MNS. More...
 
- 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 postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
const std::string & prefix () const
 
virtual void preOnConnectComponent ()
 
virtual void preOnExitComponent ()
 

Detailed Description

Definition at line 23 of file Plugin.h.

Constructor & Destructor Documentation

◆ Plugin()

Plugin ( ManagedIceObject parent,
std::string  prefix 
)

Definition at line 18 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ ~Plugin()

~Plugin ( )
overridevirtualdefault

Member Function Documentation

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr properties)
overridevirtual

Reimplemented from ComponentPlugin.

Definition at line 28 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ postOnConnectComponent()

void postOnConnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 79 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ postOnInitComponent()

void postOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 59 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ preOnDisconnectComponent()

void preOnDisconnectComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 95 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ preOnInitComponent()

void preOnInitComponent ( )
overridevirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 50 of file Plugin.cpp.

+ Here is the call graph for this function:

◆ registerServer()

mns::dto::RegisterServerResult registerServer ( armarx::Component parent)
protected

Register the parent component in the MNS.

Called before onConnect() if MNS is enabled.

Definition at line 166 of file Plugin.cpp.

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

◆ removeServer()

mns::dto::RemoveServerResult removeServer ( )
protected

Remove the parent component from the MNS.

Called before onDisconnect() if MNS is enabled.

Definition at line 198 of file Plugin.cpp.

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

◆ setMemoryName()

void setMemoryName ( const std::string &  memoryName)

Set the name of the wm and the ltm.

Definition at line 154 of file Plugin.cpp.

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

Member Data Documentation

◆ iceAdapter

Helps connecting memory to ice. Used to handle Ice callbacks.

Definition at line 66 of file Plugin.h.

◆ longtermMemory

server::ltm::Memory longtermMemory

A manager class for the ltm. It internally holds a normal wm instance as a cache.

Definition at line 80 of file Plugin.h.

◆ memoryTopic

client::MemoryListenerInterfacePrx memoryTopic

Available after onConnect().

Definition at line 74 of file Plugin.h.

◆ memoryTopicName

std::string memoryTopicName

Available at onInit().

Definition at line 72 of file Plugin.h.

◆ workingMemory

server::wm::Memory workingMemory

The actual memory.

Definition at line 63 of file Plugin.h.


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