App::PropertyLinkList Class Reference

#include <PropertyLinks.h>

Inheritance diagram for App::PropertyLinkList:

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

Detailed Description

Definition at line 167 of file PropertyLinks.h.

Constructor & Destructor Documentation

PropertyLinkList::PropertyLinkList ( )

A constructor.

A more elaborate description of the constructor.

Definition at line 336 of file PropertyLinks.cpp.

Referenced by Copy().

PropertyLinkList::~PropertyLinkList ( ) [virtual]

A destructor.

A more elaborate description of the destructor.

Definition at line 341 of file PropertyLinks.cpp.

Member Function Documentation

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

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

Implements App::Property.

Definition at line 462 of file PropertyLinks.cpp.

References draftTools::p, and PropertyLinkList().

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

Reimplemented from App::PropertyLists.

Definition at line 330 of file PropertyLinks.cpp.

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

Reimplemented from App::PropertyLists.

Definition at line 330 of file PropertyLinks.cpp.

Referenced by App::Document::breakDependency(), and Gui::TaskView::TaskSelectLinkProperty::TaskSelectLinkProperty().

unsigned int PropertyLinkList::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 476 of file PropertyLinks.cpp.

PyObject * PropertyLinkList::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 373 of file PropertyLinks.cpp.

References Py::asObject(), RobotExampleTrajectoryOutOfShapes::count, getSize(), Py::new_reference_to(), and Py::SeqBase< T >::setItem().

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

Implements App::PropertyLists.

Definition at line 351 of file PropertyLinks.cpp.

Referenced by Part::Loft::execute(), getPyObject(), and Save().

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

Reimplemented from App::PropertyLists.

Definition at line 330 of file PropertyLinks.cpp.

Referenced by Restore().

const std::vector<DocumentObject*>& App::PropertyLinkList::getValues ( void ) const [inline]

Definition at line 202 of file PropertyLinks.h.

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

Reimplemented from App::PropertyLists.

Definition at line 330 of file PropertyLinks.cpp.

DocumentObject* App::PropertyLinkList::operator[] ( const int idx ) const [inline]

index operator

Definition at line 193 of file PropertyLinks.h.

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

Definition at line 469 of file PropertyLinks.cpp.

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

void PropertyLinkList::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 430 of file PropertyLinks.cpp.

References Base::Console(), RobotExampleTrajectoryOutOfShapes::count, Base::XMLReader::getAttribute(), Base::XMLReader::getAttributeAsInteger(), App::PropertyContainer::getClassTypeId(), App::Property::getContainer(), App::DocumentObject::getDocument(), App::Document::getObject(), getTypeId(), Base::BaseClass::isDerivedFrom(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), setValues(), and Base::ConsoleSingleton::Warning().

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