Emergency 2017 Dokumentation  v3.0.1
qsf::editor::CommitOperation Class Reference

Commit operation class. More...

#include <CommitOperation.h>

Public Member Functions

 CommitOperation ()
 Constructor. More...
 
virtual ~CommitOperation ()
 Destructor. More...
 
- Public Member Functions inherited from qsf::editor::base::CommitOperation
 CommitOperation ()
 Constructor. More...
 
virtual uint32 getId () const override
 Return the unique operation identifier. More...
 
virtual bool isReplicated () const override
 Return whether or not the operation is replicated by the server to all other relevant clients. More...
 
virtual bool isReversible () const override
 Return whether or not the operation will end up in the undo/redo stack. More...
 
- Public Member Functions inherited from qsf::editor::base::Operation
virtual ~Operation ()
 Destructor. More...
 
std::string getText () const
 Return the text of the operation. More...
 
void setText (const std::string &text)
 Set the text of the operation. More...
 
uint32 getUserId () const
 Return the ID of the user issuing the operation. More...
 
void setUserId (uint32 userId)
 Set the ID of the user issuing the operation. More...
 
bool isSealed () const
 
void seal ()
 Seal the operation after constructing it using the default constructor and explicitly using setters for all parameters. More...
 
void undo ()
 Undo the operation. More...
 
void redo ()
 Redo the operation. More...
 
virtual bool isLocal () const
 Return whether or not the operation is local only. More...
 
virtual size_t getMemoryConsumption () const
 Return the memory consumption of this operation. More...
 
virtual void sealImpl ()
 Seal the operation after constructing it using the default constructor and explicitly using setters for all parameters. More...
 
virtual void undoImpl ()
 Undo the operation (common actions to always be executed) More...
 
virtual void redoImpl ()
 Redo the operation (common actions to always be executed) 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...
 

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 }
 
- Static Public Attributes inherited from qsf::editor::base::CommitOperation
static const uint32 OPERATION_ID
 "qsf::editor::base::CommitOperation" unique operation ID More...
 
- Protected Member Functions inherited from qsf::editor::base::Operation
 Operation ()
 Default constructor. More...
 
- Protected Member Functions inherited from qsf::Object
 Object ()
 Default constructor. More...
 
- Protected Attributes inherited from qsf::editor::base::Operation
CompoundOperationmParentOperation
 Parent compound operation, can be a null pointer, do not destroy the instance. More...
 

Detailed Description

Commit operation class.

Todo:
TODO(co) On the client this operation is empty, maybe we can get rid of it completely and e.g. just having a "qsf::editor::base::CommitOperation"

Definition at line 35 of file CommitOperation.h.

Constructor & Destructor Documentation

qsf::editor::CommitOperation::CommitOperation ( )

Constructor.

virtual qsf::editor::CommitOperation::~CommitOperation ( )
virtual

Destructor.

Reimplemented from qsf::editor::base::CommitOperation.


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