Part::PropertyFilletEdges Class Reference

#include <PropertyTopoShape.h>

Inheritance diagram for Part::PropertyFilletEdges:

Public Member Functions
virtual Property *	Copy (void) const
	Returns a new copy of the property (mainly for Undo/Redo and transactions).
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? This method is defined in Base::Persistence.
virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object.
virtual int	getSize (void) const
virtual Base::Type	getTypeId (void) const
const std::vector < FilletElement > &	getValues (void) const
virtual void	Paste (const Property &from)
	PropertyFilletEdges ()
virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document.
virtual 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.
virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document.
virtual void	SaveDocFile (Base::Writer &writer) const
	This method is used to save large amounts of data to a binary file.
virtual void	setPyObject (PyObject *)
virtual void	setSize (int newSize)
void	setValue (int id, double r1, double r2)
	Sets the property.
void	setValues (const std::vector< FilletElement > &values)
	~PropertyFilletEdges ()
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

Definition at line 106 of file PropertyTopoShape.h.

Constructor & Destructor Documentation

PropertyFilletEdges::PropertyFilletEdges ( )

Definition at line 340 of file PropertyTopoShape.cpp.

Referenced by Copy().

PropertyFilletEdges::~PropertyFilletEdges ( )

Definition at line 344 of file PropertyTopoShape.cpp.

Member Function Documentation

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

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

Implements App::Property.

Definition at line 438 of file PropertyTopoShape.cpp.

References draftTools::p, and PropertyFilletEdges().

void * Part::PropertyFilletEdges::create ( void ) [static]

Reimplemented from App::PropertyLists.

Definition at line 338 of file PropertyTopoShape.cpp.

Base::Type Part::PropertyFilletEdges::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyLists.

Definition at line 338 of file PropertyTopoShape.cpp.

virtual unsigned int Part::PropertyFilletEdges::getMemSize ( void ) const [inline, 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 143 of file PropertyTopoShape.h.

PyObject * PropertyFilletEdges::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 365 of file PropertyTopoShape.cpp.

References getSize(), Py::new_reference_to(), and Py::Tuple::setItem().

virtual int Part::PropertyFilletEdges::getSize ( void ) const [inline, virtual]

Implements App::PropertyLists.

Definition at line 117 of file PropertyTopoShape.h.

Referenced by getPyObject(), and SaveDocFile().

Base::Type Part::PropertyFilletEdges::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyLists.

Definition at line 338 of file PropertyTopoShape.cpp.

const std::vector<FilletElement>& Part::PropertyFilletEdges::getValues ( void ) const [inline]

Definition at line 127 of file PropertyTopoShape.h.

Referenced by Part::Fillet::execute(), and Part::Chamfer::execute().

void Part::PropertyFilletEdges::init ( void ) [static]

Reimplemented from App::PropertyLists.

Definition at line 338 of file PropertyTopoShape.cpp.

Referenced by initPart().

void PropertyFilletEdges::Paste ( const Property & from ) [virtual]

Definition at line 445 of file PropertyTopoShape.cpp.

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

void PropertyFilletEdges::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 405 of file PropertyTopoShape.cpp.

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

void PropertyFilletEdges::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 426 of file PropertyTopoShape.cpp.

References setValues().

void PropertyFilletEdges::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 398 of file PropertyTopoShape.cpp.

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

void PropertyFilletEdges::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 416 of file PropertyTopoShape.cpp.

References getSize(), and Base::Writer::Stream().

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

Reimplemented from Base::BaseClass.

Definition at line 381 of file PropertyTopoShape.cpp.

References Py::SeqBase< T >::begin(), Part::FilletElement::edgeid, Py::SeqBase< T >::end(), Py::SeqBase< T >::getItem(), Py::int, Part::FilletElement::radius1, Part::FilletElement::radius2, setValues(), and Py::SeqBase< T >::size().

virtual void Part::PropertyFilletEdges::setSize ( int newSize ) [inline, virtual]

Implements App::PropertyLists.

Definition at line 114 of file PropertyTopoShape.h.

void PropertyFilletEdges::setValue	(	int	id,
		double	r1,
		double	r2
	)

Sets the property.

Definition at line 348 of file PropertyTopoShape.cpp.

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

void PropertyFilletEdges::setValues ( const std::vector< FilletElement > & values )

Definition at line 358 of file PropertyTopoShape.cpp.

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

Referenced by RestoreDocFile(), and setPyObject().

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

Part::PropertyFilletEdges Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation