SpecializedProviderSegment Class Reference

A base class for provider segments. More...

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

+ Inheritance diagram for SpecializedProviderSegment:

Classes

struct  Properties
 

Public Member Functions

virtual void defineProperties (armarx::PropertyDefinitionsPtr defs, const std::string &prefix="") override
 
wm::ProviderSegmentgetProviderSegment ()
 
const wm::ProviderSegmentgetProviderSegment () const
 
virtual void init () override
 
void setAronType (aron::type::ObjectPtr aronType)
 
void setDefaultMaxHistorySize (int64_t maxHistorySize)
 
void setDefaultProviderSegmentName (const std::string &providerSegmentName)
 
void setPredictionEngines (const std::vector< PredictionEngine > &predictionEngines)
 
 SpecializedProviderSegment (MemoryToIceAdapter &iceMemory, const std::string &defaultProviderSegmentName="", const std::string &defaultCoreSegmentName="", aron::type::ObjectPtr providerSegmentAronType=nullptr, aron::type::ObjectPtr coreSegmentAronType=nullptr, int defaultMaxHistorySize=-1, const std::vector< PredictionEngine > &providerSegmentPredictionEngines={}, const std::vector< PredictionEngine > &coreSegmentPredictionEngines={})
 
virtual ~SpecializedProviderSegment () override
 
- Public Member Functions inherited from SegmentBase< server::wm::ProviderSegment >
MemoryIDid ()
 
const MemoryIDid () const
 
 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

aron::type::ObjectPtr aronType
 
SpecializedCoreSegment coreSegment
 
std::vector< PredictionEnginepredictionEngines
 
Properties properties
 
- Public Attributes inherited from SegmentBase< server::wm::ProviderSegment >
server::wm::ProviderSegmentsegmentPtr
 

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
 
- Protected Attributes inherited from SegmentBase< server::wm::ProviderSegment >
MemoryToIceAdaptericeMemory
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

A base class for provider segments.

Definition at line 20 of file SpecializedProviderSegment.h.

Constructor & Destructor Documentation

◆ SpecializedProviderSegment()

SpecializedProviderSegment ( MemoryToIceAdapter iceMemory,
const std::string &  defaultProviderSegmentName = "",
const std::string &  defaultCoreSegmentName = "",
aron::type::ObjectPtr  providerSegmentAronType = nullptr,
aron::type::ObjectPtr  coreSegmentAronType = nullptr,
int  defaultMaxHistorySize = -1,
const std::vector< PredictionEngine > &  providerSegmentPredictionEngines = {},
const std::vector< PredictionEngine > &  coreSegmentPredictionEngines = {} 
)

Definition at line 12 of file SpecializedProviderSegment.cpp.

◆ ~SpecializedProviderSegment()

~SpecializedProviderSegment ( )
overridevirtual

Definition at line 35 of file SpecializedProviderSegment.cpp.

Member Function Documentation

◆ defineProperties()

void defineProperties ( armarx::PropertyDefinitionsPtr  defs,
const std::string &  prefix = "" 
)
overridevirtual

Implements SegmentBase< server::wm::ProviderSegment >.

Reimplemented in StatechartListenerProviderSegment, LightweightCpuMonitorProviderSegment, LightweightRamMonitorProviderSegment, MDBMotionSegment, and MPSegment.

Definition at line 40 of file SpecializedProviderSegment.cpp.

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

◆ getProviderSegment() [1/2]

const wm::ProviderSegment & getProviderSegment ( )

Definition at line 103 of file SpecializedProviderSegment.cpp.

◆ getProviderSegment() [2/2]

const wm::ProviderSegment& getProviderSegment ( ) const

◆ init()

void init ( )
overridevirtual

Implements SegmentBase< server::wm::ProviderSegment >.

Reimplemented in LightweightCpuMonitorProviderSegment, LightweightRamMonitorProviderSegment, MDBMotionSegment, MPSegment, KnownGraspProviderSegment, and StatechartListenerProviderSegment.

Definition at line 56 of file SpecializedProviderSegment.cpp.

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

◆ setAronType()

void setAronType ( aron::type::ObjectPtr  aronType)

Definition at line 91 of file SpecializedProviderSegment.cpp.

◆ setDefaultMaxHistorySize()

void setDefaultMaxHistorySize ( int64_t  maxHistorySize)

Definition at line 85 of file SpecializedProviderSegment.cpp.

+ Here is the caller graph for this function:

◆ setDefaultProviderSegmentName()

void setDefaultProviderSegmentName ( const std::string &  providerSegmentName)

Definition at line 79 of file SpecializedProviderSegment.cpp.

◆ setPredictionEngines()

void setPredictionEngines ( const std::vector< PredictionEngine > &  predictionEngines)

Definition at line 97 of file SpecializedProviderSegment.cpp.

Member Data Documentation

◆ aronType

Definition at line 53 of file SpecializedProviderSegment.h.

◆ coreSegment

Definition at line 55 of file SpecializedProviderSegment.h.

◆ predictionEngines

std::vector<PredictionEngine> predictionEngines

Definition at line 54 of file SpecializedProviderSegment.h.

◆ properties

Properties properties

Definition at line 62 of file SpecializedProviderSegment.h.


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