Conscience Core
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove Class Reference

#include <environmentEntitiesCommands.h>

Inheritance diagram for conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove:
conscience_core::bridging::commands::CscCommand

Public Member Functions

 CommandEntitiesRemove (const EntitiesGetFiltersCommandDataType *filters=nullptr)
 
 ~CommandEntitiesRemove () override
 
- Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
const CscCommandExecutionResult_execute (CscEnvironmentSimulator &environmentSimulator)
 
template<class TResult = CscCommandExecutionResult>
const TResult * execute (CscEnvironmentSimulator &environmentSimulator)
 
const CommandTypeIdgetTypeId () const
 
virtual ~CscCommand ()
 
void setOriginalCommandString (string command)
 

Static Public Attributes

static const CommandTypeId COMMAND_ID = "ENTITIES_REMOVE"
 

Protected Member Functions

const CscCommandExecutionResultList< string > * doExecute (CscEnvironmentSimulator &environmentSimulator) override
 
ptr< CscEntityReflexiongetEntityReflexion () const override
 
- Protected Member Functions inherited from conscience_core::bridging::commands::CscCommand
 CscCommand (const CommandTypeId &typeId)
 
const CscCommandExecutionResultNoneresultNone ()
 
const CscCommandExecutionResultSequenceresultSequence (CscSequence *sequence, const string &entitySerialNumber, bool doNotPlay=false)
 
const CscCommandExecutionResultFileresultFile (const fs::path &resultingFilePath)
 
template<class TResult >
const CscCommandExecutionResultObject< TResult > * resultObject (TResult *result)
 
const CscWorldElementId getEntityId () const
 

Additional Inherited Members

- Public Types inherited from conscience_core::bridging::commands::CscCommand
typedef function< void(CscCommand *command)> CommandExecutedListener
 
- Static Public Member Functions inherited from conscience_core::bridging::commands::CscCommand
static void addCommandExecutedListener (CommandExecutedListener listener)
 
- Protected Attributes inherited from conscience_core::bridging::commands::CscCommand
const CommandTypeId typeId
 
optional< string > originalCommandString = {}
 

Detailed Description

The command removes entities returned by given filters and stops "reflection" on them. Returns removed entities ids.

Constructor & Destructor Documentation

◆ CommandEntitiesRemove()

conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove::CommandEntitiesRemove ( const EntitiesGetFiltersCommandDataType filters = nullptr)

◆ ~CommandEntitiesRemove()

conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove::~CommandEntitiesRemove ( )
override

Member Function Documentation

◆ doExecute()

const CscCommandExecutionResultList< string > * conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove::doExecute ( CscEnvironmentSimulator environmentSimulator)
overrideprotectedvirtual

◆ getEntityReflexion()

ptr< CscEntityReflexion > conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove::getEntityReflexion ( ) const
overrideprotectedvirtual

return entity reflexion if this command applies on an entityReflexion, otherwise return nullptr

Implements conscience_core::bridging::commands::CscCommand.

Member Data Documentation

◆ COMMAND_ID

const CommandTypeId conscience_core::bridging::commands::environment_entities::CommandEntitiesRemove::COMMAND_ID = "ENTITIES_REMOVE"
inlinestatic

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