Persistence class and root of the type system. More...

#include <Persistence.h>

Public Member Functions
void	dumpToStream (std::ostream &stream, int compression)

virtual unsigned int	getMemSize () const =0
	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 Base::Type	getTypeId (void) const

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

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	Save (Writer &) const =0
	This method is used to save properties to an XML document. More...

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...

	BaseClass (const BaseClass &)=default

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

virtual Type	getTypeId () const

bool	isDerivedFrom (const Type type) const

BaseClass &	operator= (const BaseClass &)=default

virtual void	setPyObject (PyObject *)

virtual	~BaseClass ()
	Destruction. More...

Static Public Member Functions
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 ()

static Type	getClassTypeId ()

static void	init ()

Additional Inherited Members
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

Persistence class and root of the type system.

Member Function Documentation

◆ create()

void * Base::Persistence::create ( void )

static

Referenced by draftguitools.gui_labels.Label::action().

◆ dumpToStream()

void Persistence::dumpToStream	(	std::ostream &	stream,
		int	compression
	)

References Base::ZipWriter::putNextEntry(), Save(), Base::ZipWriter::setLevel(), Base::Writer::setMode(), Base::ZipWriter::Stream(), and Base::ZipWriter::writeFiles().

◆ encodeAttribute()

std::string Persistence::encodeAttribute ( const std::string & str )

static

Encodes an attribute upon saving.

◆ getClassTypeId()

Base::Type Base::Persistence::getClassTypeId ( void )

static

◆ getMemSize()

unsigned int Persistence::getMemSize ( void ) const

pure 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?

Implemented in App::PropertyFileIncluded, Mesh::MeshObject, Mesh::PropertyNormalList, Mesh::PropertyCurvatureList, Mesh::PropertyMeshKernel, Points::PointKernel, Points::PropertyGreyValueList, Points::PropertyNormalList, Points::PropertyCurvatureList, Points::PropertyPointKernel, App::PropertyRotation, App::MergeDocuments, App::PropertyContainer, App::PropertyMatrix, App::PropertyPythonObject, App::PropertyInteger, App::PropertyPath, App::PropertyIntegerSet, App::PropertyMap, App::PropertyFloat, App::PropertyString, App::PropertyUUID, App::PropertyBool, App::PropertyColor, App::PropertyMaterial, App::Transaction, App::TransactionObject, Gui::Document, Gui::MergeDocuments, Gui::Thumbnail, Fem::FemMesh, Fem::PropertyFemMesh, Fem::PropertyPostDataObject, Inspection::PropertyDistanceList, Part::Geometry, Part::GeomPoint, Part::GeomBezierCurve, Part::GeomBSplineCurve, Part::GeomTrimmedCurve, Part::GeomCircle, Part::GeomArcOfCircle, Part::GeomEllipse, Part::GeomArcOfEllipse, Part::GeomHyperbola, Part::GeomArcOfHyperbola, Part::GeomParabola, Part::GeomArcOfParabola, Part::GeomLine, Part::GeomLineSegment, Part::GeomOffsetCurve, Part::GeomBezierSurface, Part::GeomBSplineSurface, Part::GeomCylinder, Part::GeomCone, Part::GeomSphere, Part::GeomToroid, Part::GeomPlane, Part::GeomOffsetSurface, Part::GeomPlateSurface, Part::GeomTrimmedSurface, Part::GeomSurfaceOfRevolution, Part::GeomSurfaceOfExtrusion, Part::Geometry2d, Part::Geom2dPoint, Part::Geom2dBezierCurve, Part::Geom2dBSplineCurve, Part::Geom2dCircle, Part::Geom2dArcOfCircle, Part::Geom2dEllipse, Part::Geom2dArcOfEllipse, Part::Geom2dHyperbola, Part::Geom2dArcOfHyperbola, Part::Geom2dParabola, Part::Geom2dArcOfParabola, Part::Geom2dLine, Part::Geom2dLineSegment, Part::Geom2dOffsetCurve, Part::Geom2dTrimmedCurve, Part::PropertyGeometryList, Part::PropertyPartShape, Part::PropertyShapeHistory, Part::PropertyFilletEdges, Part::TopoShape, Path::Command, Path::Toolpath, Path::PropertyPath, Path::PropertyTool, Path::PropertyTooltable, Path::Tool, Path::Tooltable, Robot::PropertyTrajectory, Robot::Robot6Axis, Robot::Trajectory, Robot::Waypoint, Sketcher::Sketch, TechDraw::CosmeticVertex, TechDraw::CosmeticEdge, TechDraw::CenterLine, TechDraw::GeomFormat, TechDraw::DrawParametricTemplate, TechDraw::DrawSVGTemplate, TechDraw::DrawTemplate, TechDraw::PropertyCenterLineList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, Part::GeomConic, Part::GeomArcOfConic, Part::Geom2dConic, Part::Geom2dArcOfConic, App::Document, App::Property, App::PropertyExpressionEngine, App::PropertyVector, App::PropertyVectorList, App::PropertyPlacement, App::PropertyPlacementList, App::PropertyLink, App::PropertyLinkList, App::PropertyLinkSub, App::PropertyLinkSubList, App::PropertyXLinkSubList, App::PropertyIntegerList, App::PropertyFloatList, App::PropertyStringList, App::PropertyBoolList, App::PropertyColorList, App::PropertyMaterialList, App::PropertyPersistentObject, Gui::DocumentItem, Sketcher::Constraint, Sketcher::PropertyConstraintList, Sketcher::SketchObject, and Spreadsheet::PropertySheet.

◆ getTypeId()

Base::Type Base::Persistence::getTypeId ( void ) const

virtual

Reimplemented from Base::BaseClass.

◆ init()

void Base::Persistence::init ( void )

static

Referenced by App::Application::initTypes(), Gui::Application::initTypes(), DocumentObject.DocumentObject::onChanged(), PartDesign::SubShapeBinder::update(), and MeshGui::ViewProviderMeshCurvature::updateData().

◆ Restore()

void Persistence::Restore ( XMLReader & )

pure 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 = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Implemented in Fem::FemMesh, Part::Geometry, Part::GeomPoint, Part::GeomBezierCurve, Part::GeomBSplineCurve, Part::GeomTrimmedCurve, Part::GeomCircle, Part::GeomArcOfCircle, Part::GeomEllipse, Part::GeomArcOfEllipse, Part::GeomHyperbola, Part::GeomArcOfHyperbola, Part::GeomParabola, Part::GeomArcOfParabola, Part::GeomLine, Part::GeomLineSegment, Part::GeomOffsetCurve, Part::GeomBezierSurface, Part::GeomBSplineSurface, Part::GeomCylinder, Part::GeomCone, Part::GeomSphere, Part::GeomToroid, Part::GeomPlane, Part::GeomOffsetSurface, Part::GeomPlateSurface, Part::GeomTrimmedSurface, Part::GeomSurfaceOfRevolution, Part::GeomSurfaceOfExtrusion, Part::Geometry2d, Part::Geom2dPoint, Part::Geom2dBezierCurve, Part::Geom2dBSplineCurve, Part::Geom2dCircle, Part::Geom2dArcOfCircle, Part::Geom2dEllipse, Part::Geom2dArcOfEllipse, Part::Geom2dHyperbola, Part::Geom2dArcOfHyperbola, Part::Geom2dParabola, Part::Geom2dArcOfParabola, Part::Geom2dLine, Part::Geom2dLineSegment, Part::Geom2dOffsetCurve, Part::Geom2dTrimmedCurve, Path::Command, Path::Toolpath, Path::Tool, Path::Tooltable, Robot::Robot6Axis, Robot::RobotObject, Robot::Trajectory, Robot::Waypoint, Sketcher::Sketch, TechDraw::CosmeticVertex, TechDraw::CosmeticEdge, TechDraw::CenterLine, TechDraw::GeomFormat, Gui::DocumentItem, Sketcher::Constraint, Sketcher::SketchObject, App::MergeDocuments, Gui::MergeDocuments, App::PropertyContainer, App::PropertyFileIncluded, App::PropertyMatrix, App::PropertyPythonObject, App::PropertyInteger, App::PropertyPath, App::PropertyEnumeration, App::PropertyIntegerSet, App::PropertyMap, App::PropertyFloat, App::PropertyString, App::PropertyUUID, App::PropertyBool, App::PropertyColor, App::PropertyMaterial, App::Transaction, App::TransactionObject, App::VRMLObject, Gui::Document, Gui::Thumbnail, Gui::ViewProvider, Fem::PropertyFemMesh, Fem::PropertyPostDataObject, Inspection::PropertyDistanceList, Mesh::MeshObject, Mesh::PropertyNormalList, Mesh::PropertyCurvatureList, Mesh::PropertyMeshKernel, Part::Box, Part::Circle, Part::Ellipse, Part::PropertyGeometryList, Part::PropertyPartShape, Part::PropertyShapeHistory, Part::PropertyFilletEdges, Part::TopoShape, PartGui::ViewProvider2DObjectGrid, PartDesign::Plane, PartDesign::Fillet, PartDesign::Hole, PartDesign::ProfileBased, PartDesign::Transformed, Path::PropertyPath, Path::PropertyTool, Path::PropertyTooltable, Points::PointKernel, Points::Feature, Points::PropertyGreyValueList, Points::PropertyNormalList, Points::PropertyCurvatureList, Points::PropertyPointKernel, Robot::PropertyTrajectory, Spreadsheet::PropertyColumnWidths, Spreadsheet::PropertyRowHeights, TechDraw::PropertyCenterLineList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, App::Document, App::ExtensionContainer, App::PropertyExpressionEngine, App::PropertyVector, App::PropertyVectorList, App::PropertyPlacement, App::PropertyPlacementList, App::PropertyRotation, App::PropertyLink, App::PropertyLinkList, App::PropertyLinkSub, App::PropertyLinkSubList, App::PropertyXLink, App::PropertyXLinkSubList, App::PropertyXLinkContainer, App::PropertyIntegerList, App::PropertyFloatList, App::PropertyStringList, App::PropertyBoolList, App::PropertyColorList, App::PropertyMaterialList, App::PropertyPersistentObject, Part::Part2DObject, Part::Primitive, PartDesign::Chamfer, Sketcher::PropertyConstraintList, Spreadsheet::PropertySheet, and TechDraw::DrawViewDimension.

Referenced by restoreFromStream().

◆ RestoreDocFile()

void Persistence::RestoreDocFile ( Reader & )

virtual

This method is used to restore large amounts of data from a file In this method you simply stream in your 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{
    // initiate 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 in App::MergeDocuments, Gui::MergeDocuments, App::PropertyFileIncluded, App::PropertyPythonObject, App::VRMLObject, Gui::Document, Gui::Thumbnail, Fem::FemMesh, Fem::PropertyFemMesh, Fem::PropertyPostDataObject, Inspection::PropertyDistanceList, Mesh::MeshObject, Mesh::PropertyNormalList, Mesh::PropertyCurvatureList, Mesh::PropertyMeshKernel, Part::PropertyPartShape, Part::PropertyShapeHistory, Part::PropertyFilletEdges, Part::TopoShape, Path::Toolpath, Path::PropertyPath, Points::PointKernel, Points::Feature, Points::PropertyGreyValueList, Points::PropertyNormalList, Points::PropertyCurvatureList, Points::PropertyPointKernel, App::PropertyVectorList, App::PropertyPlacementList, App::PropertyFloatList, App::PropertyColorList, and App::PropertyMaterialList.

◆ restoreFromStream()

void Persistence::restoreFromStream ( std::istream & stream )

References Base::XMLReader::isValid(), Base::XMLReader::readElement(), Base::XMLReader::readFiles(), and Restore().

◆ Save()

void Persistence::Save ( Writer & ) const

pure 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.

See also: Base::Writer

Implemented in Fem::FemMesh, Part::Geometry, Part::GeomPoint, Part::GeomBezierCurve, Part::GeomBSplineCurve, Part::GeomTrimmedCurve, Part::GeomCircle, Part::GeomArcOfCircle, Part::GeomEllipse, Part::GeomArcOfEllipse, Part::GeomHyperbola, Part::GeomArcOfHyperbola, Part::GeomParabola, Part::GeomArcOfParabola, Part::GeomLine, Part::GeomLineSegment, Part::GeomOffsetCurve, Part::GeomBezierSurface, Part::GeomBSplineSurface, Part::GeomCylinder, Part::GeomCone, Part::GeomSphere, Part::GeomToroid, Part::GeomPlane, Part::GeomOffsetSurface, Part::GeomPlateSurface, Part::GeomTrimmedSurface, Part::GeomSurfaceOfRevolution, Part::GeomSurfaceOfExtrusion, Part::Geometry2d, Part::Geom2dPoint, Part::Geom2dBezierCurve, Part::Geom2dBSplineCurve, Part::Geom2dCircle, Part::Geom2dArcOfCircle, Part::Geom2dEllipse, Part::Geom2dArcOfEllipse, Part::Geom2dHyperbola, Part::Geom2dArcOfHyperbola, Part::Geom2dParabola, Part::Geom2dArcOfParabola, Part::Geom2dLine, Part::Geom2dLineSegment, Part::Geom2dOffsetCurve, Part::Geom2dTrimmedCurve, Path::Command, Path::Toolpath, Path::Tool, Path::Tooltable, Robot::Robot6Axis, Robot::RobotObject, Robot::Trajectory, Robot::Waypoint, Sketcher::Sketch, TechDraw::CosmeticVertex, TechDraw::CosmeticEdge, TechDraw::CenterLine, TechDraw::GeomFormat, Gui::DocumentItem, Sketcher::Constraint, Sketcher::SketchObject, App::MergeDocuments, Gui::MergeDocuments, App::PropertyContainer, App::PropertyFileIncluded, App::PropertyMatrix, App::PropertyPythonObject, App::PropertyInteger, App::PropertyPath, App::PropertyEnumeration, App::PropertyIntegerSet, App::PropertyMap, App::PropertyFloat, App::PropertyString, App::PropertyUUID, App::PropertyBool, App::PropertyColor, App::PropertyMaterial, App::Transaction, App::TransactionObject, App::VRMLObject, Gui::Document, Gui::Thumbnail, Fem::PropertyFemMesh, Fem::PropertyPostDataObject, Inspection::PropertyDistanceList, Mesh::MeshObject, Mesh::PropertyNormalList, Mesh::PropertyCurvatureList, Mesh::PropertyMeshKernel, Part::PropertyGeometryList, Part::PropertyPartShape, Part::PropertyShapeHistory, Part::PropertyFilletEdges, Part::TopoShape, Path::PropertyPath, Path::PropertyTool, Path::PropertyTooltable, Points::PointKernel, Points::PropertyGreyValueList, Points::PropertyNormalList, Points::PropertyCurvatureList, Points::PropertyPointKernel, Robot::PropertyTrajectory, Spreadsheet::PropertyColumnWidths, Spreadsheet::PropertyRowHeights, TechDraw::PropertyCenterLineList, TechDraw::PropertyCosmeticEdgeList, TechDraw::PropertyCosmeticVertexList, TechDraw::PropertyGeomFormatList, App::Document, App::DocumentObject, App::ExtensionContainer, App::PropertyExpressionEngine, App::PropertyVector, App::PropertyVectorList, App::PropertyPlacement, App::PropertyPlacementList, App::PropertyRotation, App::PropertyLink, App::PropertyLinkList, App::PropertyLinkSub, App::PropertyLinkSubList, App::PropertyXLink, App::PropertyXLinkSubList, App::PropertyXLinkContainer, App::PropertyIntegerList, App::PropertyFloatList, App::PropertyStringList, App::PropertyBoolList, App::PropertyColorList, App::PropertyMaterialList, App::PropertyPersistentObject, Sketcher::PropertyConstraintList, and Spreadsheet::PropertySheet.

Referenced by dumpToStream(), and App::Property::isSame().

◆ SaveDocFile()

void Persistence::SaveDocFile ( 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 separate 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 effectiveness. 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 in App::MergeDocuments, Gui::MergeDocuments, App::PropertyFileIncluded, App::PropertyPythonObject, App::VRMLObject, Gui::Document, Gui::Thumbnail, Fem::FemMesh, Fem::PropertyFemMesh, Fem::PropertyPostDataObject, Inspection::PropertyDistanceList, Mesh::MeshObject, Mesh::PropertyNormalList, Mesh::PropertyCurvatureList, Mesh::PropertyMeshKernel, Part::PropertyPartShape, Part::PropertyShapeHistory, Part::PropertyFilletEdges, Part::TopoShape, Path::Toolpath, Path::PropertyPath, Points::PointKernel, Points::PropertyGreyValueList, Points::PropertyNormalList, Points::PropertyCurvatureList, Points::PropertyPointKernel, App::PropertyVectorList, App::PropertyPlacementList, App::PropertyFloatList, App::PropertyColorList, and App::PropertyMaterialList.

Referenced by Gui::RecoveryRunnable::run(), Base::ZipWriter::writeFiles(), Base::FileWriter::writeFiles(), Gui::RecoveryWriter::writeFiles(), and Cloud::CloudWriter::writeFiles().

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

FreeCAD/src/Base/Persistence.h
FreeCAD/src/Base/Persistence.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ dumpToStream()

◆ encodeAttribute()

◆ getClassTypeId()

◆ getMemSize()

◆ getTypeId()

◆ init()

◆ Restore()

◆ RestoreDocFile()

◆ restoreFromStream()

◆ Save()

◆ SaveDocFile()