Represents an entry for an object in a Transaction. More...

#include <Transactions.h>

Classes
struct PropData

Public Member Functions
void addOrRemoveProperty (const Property *pcProp, bool add)

virtual void applyChn (Document &Doc, TransactionalObject *pcObj, bool Forward)

virtual void applyDel (Document &Doc, TransactionalObject *pcObj)

virtual void applyNew (Document &Doc, TransactionalObject *pcObj)

virtual unsigned int getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...

virtual void Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...

virtual void Save (Base::Writer &writer) const
	This method is used to save properties to an XML document. More...

void setProperty (const Property *pcProp)

TransactionObject ()
	Construction. More...

virtual ~TransactionObject ()
	Destruction. More...

Public Member Functions inherited from Base::Persistence
void dumpToStream (std::ostream &stream, int compression)

virtual Base::Type getTypeId (void) const

virtual void RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...

void restoreFromStream (std::istream &stream)

virtual void SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. More...

Public Member Functions inherited from Base::BaseClass
BaseClass ()
	Construction. More...

virtual PyObject * getPyObject (void)
	This method returns the Python wrapper for a C++ object. More...

bool isDerivedFrom (const Type type) const

virtual void setPyObject (PyObject *)

virtual ~BaseClass ()
	Destruction. More...

Protected Types
enum Status { New, Del, Chn }

Protected Attributes
enum App::TransactionObject::Status status

Friends
class Transaction

Additional Inherited Members
Static Public Member Functions inherited from Base::Persistence
static void * create (void)

static std::string encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...

static Base::Type getClassTypeId (void)

static void init (void)

Static Public Member Functions inherited from Base::BaseClass
static void * create (void)

static Type getClassTypeId (void)

static void init (void)

Static Protected Member Functions inherited from Base::BaseClass
static void initSubclass (Base::Type &toInit, const char ClassName, const char ParentName, Type::instantiationMethod method=nullptr)

Detailed Description

Represents an entry for an object in a Transaction.

Member Enumeration Documentation

◆ Status

enum App::TransactionObject::Status

protected

Enumerator
New
Del
Chn

Constructor & Destructor Documentation

◆ TransactionObject()

TransactionObject::TransactionObject ( )

Construction.

A constructor.

A more elaborate description of the constructor.

◆ ~TransactionObject()

TransactionObject::~TransactionObject ( )

virtual

Destruction.

A destructor.

A more elaborate description of the destructor.

Member Function Documentation

◆ addOrRemoveProperty()

void TransactionObject::addOrRemoveProperty	(	const Property *	pcProp,
		bool	add
	)

References App::Property::Copy(), App::Property::getContainer(), App::PropertyContainer::getDynamicPropertyData(), App::Property::getStatus(), Base::Persistence::getTypeId(), and App::DynamicProperty::PropData::property.

Referenced by App::Transaction::addOrRemoveProperty().

◆ applyChn()

void TransactionObject::applyChn	(	Document &	Doc,
		TransactionalObject *	pcObj,
		bool	Forward
	)

virtual

References App::PropertyContainer::addDynamicProperty(), Chn, App::PropertyContainer::getDynamicPropertyByName(), App::ExtensionContainer::getPropertyName(), New, App::PropertyContainer::removeDynamicProperty(), App::Property::setStatusValue(), and status.

◆ applyDel()

void TransactionObject::applyDel	(	Document &	Doc,
		TransactionalObject *	pcObj
	)

virtual

Reimplemented in App::TransactionDocumentObject, and Gui::TransactionViewProvider.

◆ applyNew()

void TransactionObject::applyNew	(	Document &	Doc,
		TransactionalObject *	pcObj
	)

virtual

Reimplemented in App::TransactionDocumentObject, and Gui::TransactionViewProvider.

◆ getMemSize()

unsigned int TransactionObject::getMemSize ( void ) const

virtual

This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB?

Implements Base::Persistence.

◆ Restore()

void TransactionObject::Restore ( Base::XMLReader & reader )

virtual

This method is used to restore properties from an XML document.

Implements Base::Persistence.

◆ Save()

void TransactionObject::Save ( Base::Writer & ) const

virtual

This method is used to save properties to an XML document.

A good example you'll find in PropertyStandard.cpp, e.g. the vector:

void PropertyVector::Save (Writer &writer) const
{
   writer << writer.ind() << "<PropertyVector valueX=\"" <<  _cVec.x <<
                                          "\" valueY=\"" <<  _cVec.y <<
                                          "\" valueZ=\"" <<  _cVec.z <<"\"/>" << endl;
}

The writer.ind() expression writes the indentation, just for pretty printing of the XML. As you see, the writing of the XML document is not done with a DOM implementation because of performance reasons. Therefore the programmer has to take care that a valid XML document is written. This means closing tags and writing UTF-8.