#include <RobotAPI/libraries/armem_skills/server/segment/SkillEventSegment.h>

Inheritance diagram for SkillEventCoreSegment:

Public Member Functions
void	addSkillUpdateEvent (const skills::SkillStatusUpdate &update)

std::size_t	clearAndConsolidate (armem::server::ltm::Memory &ltm, const std::string &memoryName, bool &consolidated)
	Clear all snapshots from the working memory of this core segment, consolidating them into `ltm` first if `ltm.isRecording()` returns true.

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

std::optional< skills::SkillStatusUpdate >	getSkillStatusUpdate (const skills::SkillExecutionID &id)

std::map< skills::SkillExecutionID, skills::SkillStatusUpdate >	getSkillStatusUpdates ()

void	init ()

	SkillEventCoreSegment (armem::server::MemoryToIceAdapter &iceMemory)

Public Member Functions inherited from SpecializedCoreSegment
template<class FunctionT>
auto	doLocked (FunctionT &&function) const
	Execute function under shared (read) lock.

template<class FunctionT>
auto	doLockedExclusive (FunctionT &&function)
	Execute function under exclusive (write) lock.

wm::CoreSegment &	getCoreSegment ()

const wm::CoreSegment &	getCoreSegment () const

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

void	setDefaultCoreSegmentName (const std::string &coreSegmentName)

void	setDefaultMaxHistorySize (int64_t maxHistorySize)

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

	SpecializedCoreSegment (MemoryToIceAdapter &iceMemory, const std::string &defaultCoreSegmentName="", aron::type::ObjectPtr coreSegmentAronType=nullptr, int defaultMaxHistorySize=10, const std::vector< PredictionEngine > &predictionEngines={})

virtual	~SpecializedCoreSegment () override

Public Member Functions inherited from SegmentBase< server::wm::CoreSegment >
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 ()

Static Public Attributes
static constexpr const char *	CoreSegmentName = "SkillEvent"

Additional Inherited Members
Public Attributes inherited from SpecializedCoreSegment
aron::type::ObjectPtr	aronType

std::vector< PredictionEngine >	predictionEngines

Properties	properties

Public Attributes inherited from SegmentBase< server::wm::CoreSegment >
server::wm::CoreSegment *	segmentPtr
	Set by the derived segment's init().

server::wm::CoreSegment *	segmentPtr
	Set by the derived segment's init().

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::CoreSegment >
MemoryToIceAdapter &	iceMemory

MemoryToIceAdapter &	iceMemory

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Constructor & Destructor Documentation

◆ SkillEventCoreSegment()

SkillEventCoreSegment ( armem::server::MemoryToIceAdapter & iceMemory )

Member Function Documentation

◆ addSkillUpdateEvent()

void addSkillUpdateEvent ( const skills::SkillStatusUpdate & update )

◆ clearAndConsolidate()

std::size_t clearAndConsolidate	(	armem::server::ltm::Memory &	ltm,
		const std::string &	memoryName,
		bool &	consolidated )

Clear all snapshots from the working memory of this core segment, consolidating them into ltm first if ltm.isRecording() returns true.

Mirrors the state after a fresh memory restart.

Parameters

	ltm	Target LTM; written only if recording.
	memoryName	Memory name used for the temporary WM slice.
[out]	consolidated	Set to true iff snapshots were written to LTM.

Returns: Number of snapshots that were removed from working memory.

◆ defineProperties()

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

virtual

Reimplemented from SpecializedCoreSegment.

◆ getSkillStatusUpdate()

std::optional< skills::SkillStatusUpdate > getSkillStatusUpdate ( const skills::SkillExecutionID & id )

◆ getSkillStatusUpdates()

std::map< skills::SkillExecutionID, skills::SkillStatusUpdate > getSkillStatusUpdates ( )

◆ init()

void init ( )

virtual

Reimplemented from SpecializedCoreSegment.

Member Data Documentation

◆ CoreSegmentName

const char* CoreSegmentName = "SkillEvent"

staticconstexpr

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

RobotAPI/libraries/armem_skills/server/segment/SkillEventSegment.h
RobotAPI/libraries/armem_skills/server/segment/SkillEventSegment.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members