Conscience Core
Public Member Functions | List of all members
conscience_core::sequences_processor::CscSequencesProcessor Class Reference

#include <CscSequencesProcessor.h>

Public Member Functions

 CscSequencesProcessor (const string &worldEntityId, CscEnvironmentSimulator *simulator, const bool entitySimulated)
 
 ~CscSequencesProcessor ()
 
void sequenceTic ()
 
CscSequencegetSequence ()
 
bool isSequenceProcessed ()
 
void addSequenceInQueue (CscSequence *sequence)
 
void deleteFirstSequenceFromBuffer ()
 
void deleteLastSequenceFromBuffer ()
 
int getSequenceProcessingIndex ()
 
optional< vector< const CscPoint3d * > > getCurrentPositionsOfSequence (unsigned long long **outSequenceId=nullptr)
 
void setSequenceProcessingIndex (int index)
 
void breakSequence ()
 
void resumeSequence ()
 
void terminateSequence ()
 
void clearSequences (size_t keepLastCount=0)
 Terminate the current sequence playing and clears any sequence waiting in queue SequenceProcessor becomes idle until a new sequence is added with addSequenceInQueue() More...
 

Constructor & Destructor Documentation

◆ CscSequencesProcessor()

conscience_core::sequences_processor::CscSequencesProcessor::CscSequencesProcessor ( const string &  worldEntityId,
CscEnvironmentSimulator simulator,
const bool  entitySimulated 
)

◆ ~CscSequencesProcessor()

conscience_core::sequences_processor::CscSequencesProcessor::~CscSequencesProcessor ( )

Member Function Documentation

◆ addSequenceInQueue()

void conscience_core::sequences_processor::CscSequencesProcessor::addSequenceInQueue ( CscSequence sequence)

◆ breakSequence()

void conscience_core::sequences_processor::CscSequencesProcessor::breakSequence ( )

pauses current sequence (does not stop it, one can resume it later using resumeSequence())

◆ clearSequences()

void conscience_core::sequences_processor::CscSequencesProcessor::clearSequences ( size_t  keepLastCount = 0)

Terminate the current sequence playing and clears any sequence waiting in queue SequenceProcessor becomes idle until a new sequence is added with addSequenceInQueue()

◆ deleteFirstSequenceFromBuffer()

void conscience_core::sequences_processor::CscSequencesProcessor::deleteFirstSequenceFromBuffer ( )

◆ deleteLastSequenceFromBuffer()

void conscience_core::sequences_processor::CscSequencesProcessor::deleteLastSequenceFromBuffer ( )

◆ getCurrentPositionsOfSequence()

optional< vector< const CscPoint3d * > > conscience_core::sequences_processor::CscSequencesProcessor::getCurrentPositionsOfSequence ( unsigned long long **  outSequenceId = nullptr)
Parameters
outSequenceIdif pointer not null, will be set to current sequence id -> ONLY if return is not empty
Returns
positions from current sequence of positions or empty if no sequence of positions is currently being processed

◆ getSequence()

CscSequence * conscience_core::sequences_processor::CscSequencesProcessor::getSequence ( )

◆ getSequenceProcessingIndex()

int conscience_core::sequences_processor::CscSequencesProcessor::getSequenceProcessingIndex ( )

◆ isSequenceProcessed()

bool conscience_core::sequences_processor::CscSequencesProcessor::isSequenceProcessed ( )

◆ resumeSequence()

void conscience_core::sequences_processor::CscSequencesProcessor::resumeSequence ( )

◆ sequenceTic()

void conscience_core::sequences_processor::CscSequencesProcessor::sequenceTic ( )

◆ setSequenceProcessingIndex()

void conscience_core::sequences_processor::CscSequencesProcessor::setSequenceProcessingIndex ( int  index)

◆ terminateSequence()

void conscience_core::sequences_processor::CscSequencesProcessor::terminateSequence ( )

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