Part::PropertyGeometryList Class Reference

#include <PropertyGeometryList.h>

Inheritance diagram for Part::PropertyGeometryList:

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< Geometry * > &	getValues (void) const
const Geometry *	operator[] (const int idx) const
	index operator
virtual void	Paste (const App::Property &from)
	PropertyGeometryList ()
	A constructor.
virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document.
virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document.
virtual void	setPyObject (PyObject *)
virtual void	setSize (int newSize)
void	setValue (const Geometry *)
	Sets the property.
void	setValues (const std::vector< Geometry * > &)
virtual	~PropertyGeometryList ()
	A destructor.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

Definition at line 43 of file PropertyGeometryList.h.

Constructor & Destructor Documentation

PropertyGeometryList::PropertyGeometryList ( )

A constructor.

A more elaborate description of the constructor.

Definition at line 57 of file PropertyGeometryList.cpp.

Referenced by Copy().

PropertyGeometryList::~PropertyGeometryList ( ) [virtual]

A destructor.

A more elaborate description of the destructor.

Definition at line 62 of file PropertyGeometryList.cpp.

Member Function Documentation

Property * PropertyGeometryList::Copy ( void ) const [virtual]

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

Implements App::Property.

Definition at line 185 of file PropertyGeometryList.cpp.

References draftTools::p, PropertyGeometryList(), and setValues().

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

Reimplemented from App::PropertyLists.

Definition at line 51 of file PropertyGeometryList.cpp.

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

Reimplemented from App::PropertyLists.

Definition at line 51 of file PropertyGeometryList.cpp.

unsigned int PropertyGeometryList::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 198 of file PropertyGeometryList.cpp.

References getSize().

PyObject * PropertyGeometryList::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 106 of file PropertyGeometryList.cpp.

References getSize().

int PropertyGeometryList::getSize ( void ) const [virtual]

Implements App::PropertyLists.

Definition at line 75 of file PropertyGeometryList.cpp.

Referenced by Sketcher::SketchObject::addGeometry(), getMemSize(), getPyObject(), Save(), SketcherGui::ViewProviderSketch::setEdit(), and SketcherGui::ViewProviderSketch::updateData().

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

Reimplemented from App::PropertyLists.

Definition at line 51 of file PropertyGeometryList.cpp.

const std::vector<Geometry*>& Part::PropertyGeometryList::getValues ( void ) const [inline]

Definition at line 73 of file PropertyGeometryList.h.

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

Reimplemented from App::PropertyLists.

Definition at line 51 of file PropertyGeometryList.cpp.

Referenced by initPart().

const Geometry* Part::PropertyGeometryList::operator[] ( const int idx ) const [inline]

index operator

Definition at line 69 of file PropertyGeometryList.h.

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

Definition at line 192 of file PropertyGeometryList.cpp.

References setValues().

void PropertyGeometryList::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 161 of file PropertyGeometryList.cpp.

References RobotExampleTrajectoryOutOfShapes::count, Base::Type::createInstance(), Base::Type::fromName(), Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), Part::Geometry::Restore(), and setValues().

void PropertyGeometryList::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.