Part::GeomCylinder Class Reference

#include <Geometry.h>

Inheritance diagram for Part::GeomCylinder:

List of all members.

Public Member Functions
virtual Geometry *	clone (void) const
	returns a cloned object
	GeomCylinder ()
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?
virtual PyObject *	getPyObject (void)
	This method returns the Python wrapper for a C++ object.
virtual Base::Type	getTypeId (void) const
const Handle_Geom_Geometry &	handle () const
virtual void	Restore (Base::XMLReader &)
	This method is used to restore properties from an XML document.
virtual void	Save (Base::Writer &) const
	This method is used to save properties to an XML document.
virtual	~GeomCylinder ()
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

---

Detailed Description

Definition at line 457 of file Geometry.h.

---

Constructor & Destructor Documentation

GeomCylinder::GeomCylinder

(

)

Definition at line 1386 of file Geometry.cpp.

Referenced by clone().

GeomCylinder::~GeomCylinder

(

)

[virtual]

Definition at line 1392 of file Geometry.cpp.

---

Member Function Documentation

Geometry * GeomCylinder::clone

(

void

)

const [virtual]

returns a cloned object

Implements Part::Geometry.

Definition at line 1401 of file Geometry.cpp.

References Part::Geometry::Construction, and GeomCylinder().

Referenced by getPyObject().

void * Part::GeomCylinder::create

(

void

)

[static]

Reimplemented from Part::GeomSurface.

Definition at line 1384 of file Geometry.cpp.

Base::Type Part::GeomCylinder::getClassTypeId

(

void

)

[static]

Reimplemented from Part::GeomSurface.

Definition at line 1384 of file Geometry.cpp.

unsigned int GeomCylinder::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?

Reimplemented from Part::Geometry.

Definition at line 1410 of file Geometry.cpp.

PyObject * GeomCylinder::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 1414 of file Geometry.cpp.

References clone().

Base::Type Part::GeomCylinder::getTypeId

(

void

)

const [virtual]

Reimplemented from Part::GeomSurface.

Definition at line 1384 of file Geometry.cpp.

const Handle_Geom_Geometry & GeomCylinder::handle

(

)

const [virtual]

Implements Part::Geometry.

Definition at line 1396 of file Geometry.cpp.

Referenced by Part::TopoShapeFacePy::getSurface(), and Part::CylinderPy::PyInit().

void Part::GeomCylinder::init

(

void

)

[static]

Reimplemented from Part::GeomSurface.

Definition at line 1384 of file Geometry.cpp.

Referenced by initPart().

void GeomCylinder::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");
 }

Reimplemented from Part::Geometry.

Definition at line 1412 of file Geometry.cpp.

void GeomCylinder::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

Reimplemented from Part::Geometry.

Definition at line 1411 of file Geometry.cpp.

---

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

• Geometry.h
• Geometry.cpp