Fem::PropertyFemMesh Class Reference

The part shape property class. More...

#include <FemMeshProperty.h>

Inheritance diagram for Fem::PropertyFemMesh:

Public Member Functions
virtual Base::Type	getTypeId (void) const
	PropertyFemMesh ()
	~PropertyFemMesh ()
Save/restore

App::Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions).
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? This method is defined in Base::Persistence.
void	Paste (const App::Property &from)
void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document.
void	RestoreDocFile (Base::Reader &reader)
	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 &writer) const
	This method is used to save properties to an XML document.
void	SaveDocFile (Base::Writer &writer) const
	This method is used to save large amounts of data to a binary file.
Getting basic geometric entities

Base::BoundBox3d	getBoundingBox () const
	Returns the bounding box around the underlying mesh kernel.
void	getFaces (std::vector< Base::Vector3d > &Points, std::vector< Data::ComplexGeoData::Facet > &Topo, float Accuracy, uint16_t flags=0) const
void	transformGeometry (const Base::Matrix4D &rclMat)
	Applies a transformation on the real geometric data type.
Getter/setter

const Data::ComplexGeoData *	getComplexData () const
const FemMesh &	getValue (void) const
	get the FemMesh shape
void	setValue (const FemMesh &)
	set the FemMesh shape
void	setValuePtr (FemMesh *mesh)
Python interface

PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object.
void	setPyObject (PyObject *value)
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

The part shape property class.

Author:: Werner Mayer

Definition at line 38 of file FemMeshProperty.h.

Constructor & Destructor Documentation

PropertyFemMesh::PropertyFemMesh ( )

Definition at line 46 of file FemMeshProperty.cpp.

Referenced by Copy().

PropertyFemMesh::~PropertyFemMesh ( )

Definition at line 50 of file FemMeshProperty.cpp.

Member Function Documentation

App::Property * PropertyFemMesh::Copy ( void ) const [virtual]

Returns a new copy of the property (mainly for Undo/Redo and transactions).

Implements App::Property.

Definition at line 120 of file FemMeshProperty.cpp.

References PropertyFemMesh().

void * Fem::PropertyFemMesh::create ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 44 of file FemMeshProperty.cpp.

Base::BoundBox3d PropertyFemMesh::getBoundingBox ( ) const [virtual]

Returns the bounding box around the underlying mesh kernel.

Implements App::PropertyComplexGeoData.

Definition at line 81 of file FemMeshProperty.cpp.

Base::Type Fem::PropertyFemMesh::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 44 of file FemMeshProperty.cpp.

Referenced by FemGui::ViewProviderFemMesh::updateData().

const Data::ComplexGeoData * PropertyFemMesh::getComplexData ( ) const [virtual]

Implements App::PropertyComplexGeoData.

Definition at line 76 of file FemMeshProperty.cpp.

void PropertyFemMesh::getFaces	(	std::vector< Base::Vector3d > &	Points,
		std::vector< Data::ComplexGeoData::Facet > &	Topo,
		float	Accuracy,
		uint16_t	flags = `0`
	)			const `[virtual]`

Implements App::PropertyComplexGeoData.

Definition at line 93 of file FemMeshProperty.cpp.

unsigned int PropertyFemMesh::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? This method is defined in Base::Persistence.

See also:: Base::Persistence

Reimplemented from App::Property.

Definition at line 134 of file FemMeshProperty.cpp.

PyObject * PropertyFemMesh::getPyObject ( void ) [virtual]

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

Definition at line 100 of file FemMeshProperty.cpp.

References Mesh2Shape::mesh, and Base::PyObjectBase::setConst().

Base::Type Fem::PropertyFemMesh::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 44 of file FemMeshProperty.cpp.

const FemMesh & PropertyFemMesh::getValue ( void ) const

get the FemMesh shape

Definition at line 71 of file FemMeshProperty.cpp.

Referenced by FemGui::ViewProviderFEMMeshBuilder::createMesh().

void Fem::PropertyFemMesh::init ( void ) [static]

Reimplemented from App::PropertyComplexGeoData.

Definition at line 44 of file FemMeshProperty.cpp.

Referenced by initFem().

void PropertyFemMesh::Paste ( const App::Property & from )

Definition at line 127 of file FemMeshProperty.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

void PropertyFemMesh::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 149 of file FemMeshProperty.cpp.

References Base::XMLReader::addFile(), DrawingExample::file, Base::XMLReader::getAttribute(), and Base::XMLReader::readElement().

void PropertyFemMesh::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 165 of file FemMeshProperty.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

void PropertyFemMesh::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 139 of file FemMeshProperty.cpp.

References Base::Writer::addFile(), Base::Writer::ind(), Base::Writer::isForceXML(), and Base::Writer::Stream().

void PropertyFemMesh::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 160 of file FemMeshProperty.cpp.

void PropertyFemMesh::setPyObject ( PyObject * value ) [virtual]

Reimplemented from Base::BaseClass.

Definition at line 107 of file FemMeshProperty.cpp.

References draftlibs::dxfReader::error(), Fem::FemMeshPy::getFemMeshPtr(), setValue(), and Fem::FemMeshPy::Type.

void PropertyFemMesh::setValue ( const FemMesh & sh )

set the FemMesh shape

Definition at line 64 of file FemMeshProperty.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

Referenced by setPyObject().

void PropertyFemMesh::setValuePtr ( FemMesh * mesh )

Definition at line 54 of file FemMeshProperty.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

Referenced by importer(), and open().

void PropertyFemMesh::transformGeometry ( const Base::Matrix4D & rclMat ) [virtual]

Applies a transformation on the real geometric data type.

Implements App::PropertyComplexGeoData.

Definition at line 86 of file FemMeshProperty.cpp.

References App::Property::aboutToSetValue(), and App::Property::hasSetValue().

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

Fem::PropertyFemMesh Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation