App::PropertyVectorList Class Reference

#include <PropertyGeo.h>

Inheritance diagram for App::PropertyVectorList:

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 < Base::Vector3f > &	getValues (void) const
const Base::Vector3f &	operator[] (const int idx) const
	index operator
virtual void	Paste (const Property &from)
	PropertyVectorList ()
	A constructor.
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.
void	set1Value (const int idx, const Base::Vector3f &value)
virtual void	setPyObject (PyObject *)
virtual void	setSize (int newSize)
void	setValue (float x, float y, float z)
void	setValue (const Base::Vector3f &)
	Sets the property.
void	setValues (const std::vector< Base::Vector3f > &values)
	~PropertyVectorList ()
	A destructor.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)

Detailed Description

Definition at line 103 of file PropertyGeo.h.

Constructor & Destructor Documentation

PropertyVectorList::PropertyVectorList ( )

A constructor.

A more elaborate description of the constructor.

Definition at line 188 of file PropertyGeo.cpp.

Referenced by Copy().

PropertyVectorList::~PropertyVectorList ( )

A destructor.

A more elaborate description of the destructor.

Definition at line 193 of file PropertyGeo.cpp.

Member Function Documentation

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

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

Implements App::Property.

Definition at line 318 of file PropertyGeo.cpp.

References draftTools::p, and PropertyVectorList().

void * App::PropertyVectorList::create ( void ) [static]

Reimplemented from App::PropertyLists.

Reimplemented in Mesh::PropertyNormalList, and Points::PropertyNormalList.

Definition at line 183 of file PropertyGeo.cpp.

Base::Type App::PropertyVectorList::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyLists.

Reimplemented in Mesh::PropertyNormalList, and Points::PropertyNormalList.

Definition at line 183 of file PropertyGeo.cpp.

unsigned int PropertyVectorList::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 332 of file PropertyGeo.cpp.

PyObject * PropertyVectorList::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 234 of file PropertyGeo.cpp.

References getSize().

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

Implements App::PropertyLists.

Definition at line 206 of file PropertyGeo.cpp.

Referenced by getPyObject(), SaveDocFile(), PointsGui::ViewProviderPoints::setDisplayMode(), Points::PropertyNormalList::transform(), and Mesh::PropertyNormalList::transform().

Base::Type App::PropertyVectorList::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyLists.

Reimplemented in Mesh::PropertyNormalList, and Points::PropertyNormalList.

Definition at line 183 of file PropertyGeo.cpp.

const std::vector<Base::Vector3f>& App::PropertyVectorList::getValues ( void ) const [inline]

Definition at line 139 of file PropertyGeo.h.

Referenced by Part::Polygon::execute(), Points::PropertyNormalList::removeIndices(), and PointsGui::ViewProviderPoints::setVertexNormalMode().

void App::PropertyVectorList::init ( void ) [static]

Reimplemented from App::PropertyLists.

Reimplemented in Mesh::PropertyNormalList, and Points::PropertyNormalList.

Definition at line 183 of file PropertyGeo.cpp.

const Base::Vector3f& App::PropertyVectorList::operator[] ( const int idx ) const [inline]

index operator

Definition at line 129 of file PropertyGeo.h.

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

Definition at line 325 of file PropertyGeo.cpp.

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

void PropertyVectorList::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 285 of file PropertyGeo.cpp.

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

void PropertyVectorList::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 306 of file PropertyGeo.cpp.

References setValues().

void PropertyVectorList::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 278 of file PropertyGeo.cpp.

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

void PropertyVectorList::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 296 of file PropertyGeo.cpp.

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

void App::PropertyVectorList::set1Value	(	const int	idx,
		const Base::Vector3f &	value
	)			`[inline]`

Definition at line 133 of file PropertyGeo.h.

Referenced by Points::PropertyNormalList::transform(), and Mesh::PropertyNormalList::transform().

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

Reimplemented from Base::BaseClass.

Definition at line 244 of file PropertyGeo.cpp.

References draftlibs::dxfReader::error(), App::PropertyVector::getValue(), Base::VectorPy::getVectorPtr(), App::PropertyVector::setPyObject(), setValue(), setValues(), draftlibs::fcgeo::vec(), Base::Vector3< _Precision >::x, Base::Vector3< _Precision >::y, and Base::Vector3< _Precision >::z.

void PropertyVectorList::setSize ( int newSize ) [virtual]

Implements App::PropertyLists.

Definition at line 201 of file PropertyGeo.cpp.

void PropertyVectorList::setValue	(	float	x,
		float	y,
		float	z
	)

Definition at line 219 of file PropertyGeo.cpp.

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

void PropertyVectorList::setValue ( const Base::Vector3f & lValue )

Sets the property.

Definition at line 211 of file PropertyGeo.cpp.

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

Referenced by setPyObject().

void PropertyVectorList::setValues ( const std::vector< Base::Vector3f > & values )

Definition at line 227 of file PropertyGeo.cpp.

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

Referenced by Points::PropertyNormalList::removeIndices(), RestoreDocFile(), and setPyObject().

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

App::PropertyVectorList Class Reference

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation