Gui::MergeDocuments Class Reference

#include <MergeDocuments.h>

Inheritance diagram for Gui::MergeDocuments:

Public Member Functions
void	exportObject (const std::vector< App::DocumentObject * > &o, Base::Writer &w)
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?
void	importObject (const std::vector< App::DocumentObject * > &o, Base::XMLReader &r)
std::vector < App::DocumentObject * >	importObjects (std::istream &)
	MergeDocuments (App::Document *doc)
void	Restore (Base::XMLReader &r)
	This method is used to restore properties from an XML document.
void	RestoreDocFile (Base::Reader &r)
	This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.
void	Save (Base::Writer &w) const
	This method is used to save properties to an XML document.
void	SaveDocFile (Base::Writer &w) const
	This method is used to save large amounts of data to a binary file.
	~MergeDocuments ()

Detailed Description

Definition at line 37 of file MergeDocuments.h.

Constructor & Destructor Documentation

MergeDocuments::MergeDocuments ( App::Document * doc )

Definition at line 84 of file MergeDocuments.cpp.

References draftlibs::fcgeo::bind(), exportObject(), Gui::Application::getDocument(), importObject(), Gui::Application::Instance, App::Document::signalExportObjects, and App::Document::signalImportObjects.

MergeDocuments::~MergeDocuments ( )

Definition at line 93 of file MergeDocuments.cpp.

Member Function Documentation

void MergeDocuments::exportObject	(	const std::vector< App::DocumentObject * > &	o,
		Base::Writer &	w
	)

Definition at line 181 of file MergeDocuments.cpp.

References Save().

Referenced by MergeDocuments().

unsigned int MergeDocuments::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.

Definition at line 99 of file MergeDocuments.cpp.

void MergeDocuments::importObject	(	const std::vector< App::DocumentObject * > &	o,
		Base::XMLReader &	r
	)

Definition at line 171 of file MergeDocuments.cpp.

References Gui::Document::getViewProvider(), Gui::ViewProvider::hide(), and Restore().

Referenced by MergeDocuments().

std::vector< App::DocumentObject * > MergeDocuments::importObjects ( std::istream & input )

Definition at line 105 of file MergeDocuments.cpp.

References App::Document::addObject(), Base::Console(), Base::XMLReader::DocumentSchema, Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), App::DocumentObject::getNameInDocument(), App::Document::getObject(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), Base::XMLReader::readFiles(), App::PropertyContainer::Restore(), App::Document::signalImportObjects, and Py::type().

Referenced by StdCmdMergeProjects::activated(), and Gui::MainWindow::insertFromMimeData().

void MergeDocuments::Restore ( Base::XMLReader & ) [virtual]

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

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

 void PropertyVector::Restore(Base::XMLReader &reader)
 {
   // read my Element
   reader.readElement("PropertyVector");
   // get the value of my Attribute
   _cVec.x = (float)reader.getAttributeAsFloat("valueX");
   _cVec.y = (float)reader.getAttributeAsFloat("valueY");
   _cVec.z = (float)reader.getAttributeAsFloat("valueZ");
 }

Implements Base::Persistence.

Definition at line 192 of file MergeDocuments.cpp.

References Base::XMLReader::addFile().

Referenced by importObject().

void MergeDocuments::RestoreDocFile ( Base::Reader & ) [virtual]

This method is used to restore large amounts of data from a file In this method you simply stream in your with SaveDocFile() saved data.

Again you have to apply for the call of this method in the Restore() call:

 void PropertyMeshKernel::Restore(Base::XMLReader &reader)
 {
   reader.readElement("Mesh");
   std::string file (reader.getAttribute("file") );
 
   if(file == "")
   {
     // read XML
     MeshCore::MeshDocXML restorer(*_pcMesh);
     restorer.Restore(reader);
   }else{
     // initate a file read
     reader.addFile(file.c_str(),this);
  }
 }

After you issued the reader.addFile() your RestoreDocFile() is called:

 void PropertyMeshKernel::RestoreDocFile(Base::Reader &reader)
 {
     _pcMesh->Read( reader );
 }

See also:: Base::Reader,Base::XMLReader

Reimplemented from Base::Persistence.

Definition at line 202 of file MergeDocuments.cpp.

References Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Gui::Document::getViewProviderByName(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), and App::PropertyContainer::Restore().

void MergeDocuments::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 indention, 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.

See also:: Base::Writer

Implements Base::Persistence.

Definition at line 187 of file MergeDocuments.cpp.

References Base::Writer::addFile().

Referenced by exportObject().

void MergeDocuments::SaveDocFile ( Base::Writer & ) const [virtual]

This method is used to save large amounts of data to a binary file.

Sometimes it makes no sense to write property data as XML. In case the amount of data is too big or the data type has a more effective way to save itself. In this cases it is possible to write the data in a seperate file inside the document archive. In case you want do so you have to re-implement SaveDocFile(). First, you have to inform the framework in Save() that you want do so. Here an example from the Mesh module which can save a (pontetionaly big) triangle mesh:

 void PropertyMeshKernel::Save (Base::Writer &writer) const
 {
   if (writer.isForceXML())
   {
     writer << writer.ind() << "<Mesh>" << std::endl;
     MeshCore::MeshDocXML saver(*_pcMesh);
     saver.Save(writer);
   }else{
    writer << writer.ind() << "<Mesh file=\"" << writer.addFile("MeshKernel.bms", this) << "\"/>" << std::endl;
 }

The writer.isForceXML() is an indication to force you to write XML. Regardless of size and effectivness. The second part informs the Base::writer through writer.addFile("MeshKernel.bms", this) that this object wants to write a file with the given name. The method addFile() returns a unique name that then is written in the XML stream. This allows your RestoreDocFile() method to identify and read the file again. Later your SaveDocFile() method is called as many times as you issued the addFile() call:

 void PropertyMeshKernel::SaveDocFile (Base::Writer &writer) const
 {
     _pcMesh->Write( writer );
 }

In this method you can simply stream your content to the file (Base::Writer inheriting from ostream).

Reimplemented from Base::Persistence.

Definition at line 197 of file MergeDocuments.cpp.

References Gui::Document::exportObjects().

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

Gui::MergeDocuments Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation