SegmentBase< SegmentType > Class Template Referenceabstract

A base class for memory servers to manage their segments. More...

#include <RobotAPI/libraries/armem/server/segment/detail/SpecializedSegment.h>

+ Inheritance diagram for SegmentBase< SegmentType >:

Public Member Functions

virtual void defineProperties (armarx::PropertyDefinitionsPtr defs, const std::string &prefix="")=0
MemoryIDid ()
const MemoryIDid () const
virtual void init ()=0
 SegmentBase ()=delete
 SegmentBase (MemoryToIceAdapter &iceMemory)
virtual ~SegmentBase ()=default
- Public Member Functions inherited from Logging
SpamFilterDataPtr deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
 disables the logging for the current line for the given amount of seconds. More...
MessageTypeT getEffectiveLoggingLevel () const
 Logging ()
void setLocalMinimumLoggingLevel (MessageTypeT level)
 With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...
void setTag (const LogTag &tag)
void setTag (const std::string &tagName)
virtual ~Logging ()

Public Attributes

SegmentType * segmentPtr

Protected Attributes

- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
SpamFilterDataPtr spamFilter
LogTag tag

Additional Inherited Members

- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
const LogSenderPtrgetLogSender () const
 Retrieve log sender. More...
LogSenderPtr loghelper (const char *file, int line, const char *function) const

Detailed Description

template<class SegmentType>
class armarx::armem::server::segment::detail::SegmentBase< SegmentType >

A base class for memory servers to manage their segments.

A segment can inherit this base class and add segment specific code. TODO (fabian.peller): add concept to only accept coresegments, providersegments or entitysegments

Definition at line 24 of file SpecializedSegment.h.

Constructor & Destructor Documentation

◆ SegmentBase() [1/2]

SegmentBase ( )

◆ SegmentBase() [2/2]

SegmentBase ( MemoryToIceAdapter iceMemory)

Definition at line 29 of file SpecializedSegment.h.

◆ ~SegmentBase()

virtual ~SegmentBase ( )

Member Function Documentation

◆ defineProperties()

◆ id() [1/2]

MemoryID& id ( )

Definition at line 35 of file SpecializedSegment.h.

◆ id() [2/2]

const MemoryID& id ( ) const

Definition at line 41 of file SpecializedSegment.h.

◆ init()

Member Data Documentation

◆ iceMemory

MemoryToIceAdapter& iceMemory

Definition at line 60 of file SpecializedSegment.h.

◆ segmentPtr

SegmentType* segmentPtr

Definition at line 54 of file SpecializedSegment.h.

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