SkillExecutionRequestCoreSegment Class Reference

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

+ Inheritance diagram for SkillExecutionRequestCoreSegment:

Public Member Functions

void addSkillExecutionRequest (const skills::SkillExecutionRequest &info)
 
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.
 
skills::SkillExecutionRequest convertCommit (const aron::data::dto::DictPtr &commitData)
 
void defineProperties (PropertyDefinitionsPtr defs, const std::string &prefix)
 
void init ()
 
 SkillExecutionRequestCoreSegment (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::CoreSegmentgetCoreSegment ()
 
const wm::CoreSegmentgetCoreSegment () 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 >
MemoryIDid ()
 
MemoryIDid ()
 
const MemoryIDid () const
 
const MemoryIDid () 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 = "SkillExecutionRequest"
 

Additional Inherited Members

- Public Attributes inherited from SpecializedCoreSegment
aron::type::ObjectPtr aronType
 
std::vector< PredictionEnginepredictionEngines
 
Properties properties
 
- Public Attributes inherited from SegmentBase< server::wm::CoreSegment >
server::wm::CoreSegmentsegmentPtr
 
server::wm::CoreSegmentsegmentPtr
 
- Protected Member Functions inherited from Logging
bool checkLogLevel (MessageTypeT level) const
 
const LogSenderPtrgetLogSender () const
 Retrieve log sender.
 
LogSenderPtr loghelper (const char *file, int line, const char *function) const
 
- Protected Attributes inherited from SegmentBase< server::wm::CoreSegment >
MemoryToIceAdaptericeMemory
 
MemoryToIceAdaptericeMemory
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

Definition at line 18 of file SkillExecutionRequestSegment.h.

Constructor & Destructor Documentation

◆ SkillExecutionRequestCoreSegment()

Member Function Documentation

◆ addSkillExecutionRequest()

void addSkillExecutionRequest ( const skills::SkillExecutionRequest & info)

Definition at line 52 of file SkillExecutionRequestSegment.cpp.

+ Here is the call graph for this function:

◆ 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.

Returns
Number of snapshots removed from working memory.

Definition at line 94 of file SkillExecutionRequestSegment.cpp.

+ Here is the call graph for this function:

◆ convertCommit()

skills::SkillExecutionRequest convertCommit ( const aron::data::dto::DictPtr & commitData)

Definition at line 35 of file SkillExecutionRequestSegment.cpp.

+ Here is the call graph for this function:

◆ defineProperties()

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

Reimplemented from SpecializedCoreSegment.

Definition at line 21 of file SkillExecutionRequestSegment.cpp.

+ Here is the call graph for this function:

◆ init()

void init ( )
virtual

Reimplemented from SpecializedCoreSegment.

Definition at line 29 of file SkillExecutionRequestSegment.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ CoreSegmentName

const char* CoreSegmentName = "SkillExecutionRequest"
staticconstexpr

Definition at line 23 of file SkillExecutionRequestSegment.h.


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