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::ProviderSegment &	getProviderSegment ()
const wm::ProviderSegment &	getProviderSegment () 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=10, const std::vector< PredictionEngine > &providerSegmentPredictionEngines={}, const std::vector< PredictionEngine > &coreSegmentPredictionEngines={})
virtual	~SpecializedProviderSegment () override
Public Member Functions inherited from SegmentBase< server::wm::ProviderSegment >
MemoryID &	id ()
MemoryID &	id ()
const MemoryID &	id () const
const MemoryID &	id () const
	SegmentBase ()=delete
	SegmentBase ()=delete
	SegmentBase (MemoryToIceAdapter &iceMemory)
	SegmentBase (MemoryToIceAdapter &iceMemory)
virtual	~SegmentBase ()=default
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.
MessageTypeT	getEffectiveLoggingLevel () const
	Logging ()
void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set.
void	setTag (const LogTag &tag)
void	setTag (const std::string &tagName)
virtual	~Logging ()

Public Attributes
aron::type::ObjectPtr	aronType
SpecializedCoreSegment	coreSegment
std::vector< PredictionEngine >	predictionEngines
Properties	properties
Public Attributes inherited from SegmentBase< server::wm::ProviderSegment >
server::wm::ProviderSegment *	segmentPtr
	Set by the derived segment's init().
server::wm::ProviderSegment *	segmentPtr
	Set by the derived segment's init().

Additional Inherited Members
Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const
const LogSenderPtr &	getLogSender () const
	Retrieve log sender.
LogSenderPtr	loghelper (const char *file, int line, const char *function) const
Protected Attributes inherited from SegmentBase< server::wm::ProviderSegment >
MemoryToIceAdapter &	iceMemory
MemoryToIceAdapter &	iceMemory
Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel
SpamFilterDataPtr	spamFilter
LogTag	tag

Detailed Description

A base class for provider segments.

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 = 10,
		const std::vector< PredictionEngine > &	providerSegmentPredictionEngines = {},
		const std::vector< PredictionEngine > &	coreSegmentPredictionEngines = {} )

~SpecializedProviderSegment()

~SpecializedProviderSegment ( )

overridevirtual

Member Function Documentation

defineProperties()

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

overridevirtual

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

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

getProviderSegment() [1/2]

wm::ProviderSegment & getProviderSegment

(

)

getProviderSegment() [2/2]

const wm::ProviderSegment & getProviderSegment

(

)

const

init()

void init ( )

overridevirtual

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

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

setAronType()

void setAronType

(

aron::type::ObjectPtr

aronType

)

setDefaultMaxHistorySize()

void setDefaultMaxHistorySize

(

int64_t

maxHistorySize

)

setDefaultProviderSegmentName()

void setDefaultProviderSegmentName

(

const std::string &

providerSegmentName

)

setPredictionEngines()

void setPredictionEngines

(

const std::vector< PredictionEngine > &

predictionEngines

)

Member Data Documentation

aronType

aron::type::ObjectPtr aronType

coreSegment

SpecializedCoreSegment coreSegment

predictionEngines

std::vector<PredictionEngine> predictionEngines

properties

Properties properties

---

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

• RobotAPI/libraries/armem/server/segment/SpecializedProviderSegment.h
• RobotAPI/libraries/armem/server/segment/SpecializedProviderSegment.cpp