Emergency 2017 Dokumentation  v3.0.1
em5::editor::BatchJobGroundSpeedConverter Class Reference

Batch job for ground speed conversion. More...

#include <BatchJobGroundSpeedConverter.h>

Public Member Functions

 BatchJobGroundSpeedConverter (qsf::editor::BatchJobManager *manager)
 Constructor. More...
 
virtual ~BatchJobGroundSpeedConverter ()
 Destructor. More...
 
virtual std::string getText () const override
 
virtual void getProgress (uint32 &current, uint32 &total) const override
 
virtual bool configure () override
 Called when the job is being prepared for execution. More...
 
virtual bool work () override
 Called periodically while the job is running. More...
 
virtual void cleanup () override
 Called once when execution of the job is being stopped. More...
 
- Public Member Functions inherited from qsf::editor::BatchJob
 BatchJob (BatchJobManager *manager)
 Constructor. More...
 
virtual ~BatchJob ()
 Destructor. More...
 
uint32 getId () const
 
bool isError () const
 
const std::string & getError () const
 
void setError (const std::string &errorMessage)
 
- Public Member Functions inherited from qsf::Pluginable< BatchJobManager >
virtual ~Pluginable ()
 Destructor. More...
 
BatchJobManager & getManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::PluginableBase
virtual ~PluginableBase ()
 Destructor. More...
 
template<typename T >
T & getPluginableManager () const
 Return the pluginable manager this pluginable is in. More...
 
- Public Member Functions inherited from qsf::Object
virtual ~Object ()
 Destructor. More...
 
const camp::Class & getCampClass () const
 Return the CAMP class. More...
 
int getPropertyIndexById (const StringHash &propertyId) const
 Return the CAMP property index by using the unique class property ID. More...
 
uint32 getPropertyIdByIndex (int index) const
 Return the unique class property ID with the given index. More...
 
std::string getPropertyNameById (const StringHash &propertyId) const
 Return the CAMP property name by using the unique class property ID. More...
 
const camp::Property * getCampPropertyById (const StringHash &propertyId) const
 Return the CAMP property by using the unique class property ID. More...
 
void setPropertyValuesByString (const std::string &values)
 Set CAMP reflection property values by using a given string. More...
 
void setPropertiesToDefaultValues ()
 Set all CAMP reflection system properties to their default values. More...
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void serializeToBoostPTree (boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
bool deserializeFromBoostPTree (const boost::property_tree::ptree &pTree, const camp::Class &campClass, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL)
 
void serializeToBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL) const
 
void deserializeFromBinarySerializer (BinarySerializer &serializer, SerializationMode mode=MODE_MINIMAL, SerializationMethod serializationMethod=SERIALIZE_DIFFERENTIAL, bool setOverrideState=true)
 
virtual camp::Value getPropertyDefaultValue (const StringHash &propertyId) const
 
virtual PropertyOverrideState getPropertyOverrideState (const StringHash &propertyId) const
 
virtual bool setPropertyOverrideState (const StringHash &propertyId, PropertyOverrideState overrideState)
 
virtual void onPreDeserialize ()
 Called right before the object is deserialized using any of the above methods. Default implementation is empty. More...
 
virtual void onPostDeserialize ()
 Called right after the object was deserialized using any of the above methods. Default implementation is empty. More...
 
virtual ScriptgetAssociatedScript () const
 Return the script instance associated with this object instance. More...
 

Static Public Attributes

static const char JOB_TEXT []
 

Additional Inherited Members

- Public Types inherited from qsf::Object
enum  PropertyOverrideState { PROPERTY_INVALID, PROPERTY_DEFAULT, PROPERTY_OVERRIDE, PROPERTY_REMOVED }
 
enum  SerializationMethod { SERIALIZE_FLAT, SERIALIZE_COMPLETE, SERIALIZE_DIFFERENTIAL, SERIALIZE_IGNORE_UNKNOWN }
 
enum  SerializationMode { MODE_MINIMAL, MODE_COMPATIBLE }
 
- Public Attributes inherited from qsf::editor::BatchJob
std::string mErrorMessage
 
- Protected Member Functions inherited from qsf::Pluginable< BatchJobManager >
 Pluginable (BatchJobManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::PluginableBase
 PluginableBase (PluginableManager *pluginableManager)
 Constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 

Detailed Description

Batch job for ground speed conversion.

Todo:
  • TODO(co) Remove this batch job when possible, was only added for editing migration

Definition at line 35 of file BatchJobGroundSpeedConverter.h.

Constructor & Destructor Documentation

em5::editor::BatchJobGroundSpeedConverter::BatchJobGroundSpeedConverter ( qsf::editor::BatchJobManager manager)
explicit

Constructor.

virtual em5::editor::BatchJobGroundSpeedConverter::~BatchJobGroundSpeedConverter ( )
virtual

Destructor.

Member Function Documentation

virtual void em5::editor::BatchJobGroundSpeedConverter::cleanup ( )
overridevirtual

Called once when execution of the job is being stopped.

Returns
"false" to indicate an error and cancel execution
Note
  • This method will be called after the job is finished, got canceled or encountered an error.

Implements qsf::editor::BatchJob.

virtual bool em5::editor::BatchJobGroundSpeedConverter::configure ( )
overridevirtual

Called when the job is being prepared for execution.

Returns
"false" to indicate an error and cancel execution
Note
  • Open your config-dialogs here in case you need user input

Implements qsf::editor::BatchJob.

virtual void em5::editor::BatchJobGroundSpeedConverter::getProgress ( uint32 current,
uint32 total 
) const
overridevirtual

Implements qsf::editor::BatchJob.

virtual std::string em5::editor::BatchJobGroundSpeedConverter::getText ( ) const
overridevirtual

Implements qsf::editor::BatchJob.

virtual bool em5::editor::BatchJobGroundSpeedConverter::work ( )
overridevirtual

Called periodically while the job is running.

Returns
"true" to be called again, "false" otherwise

Implements qsf::editor::BatchJob.

Member Data Documentation

const char em5::editor::BatchJobGroundSpeedConverter::JOB_TEXT[]
static

Definition at line 43 of file BatchJobGroundSpeedConverter.h.


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