App::PropertyIntegerList Class Reference

Integer list properties. More...

#include <PropertyStandard.h>

Inheritance diagram for App::PropertyIntegerList:
App::PropertyLists App::Property Base::Persistence Base::BaseClass

List of all members.

Public Member Functions

virtual PropertyCopy (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 PyObjectgetPyObject (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< long > & getValues (void) const
long operator[] (const int idx) const
 index operator
virtual void Paste (const Property &from)
 PropertyIntegerList ()
 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, long value)
virtual void setPyObject (PyObject *)
virtual void setSize (int newSize)
void setValue (long)
 Sets the property.
void setValues (const std::vector< long > &values)
 ~PropertyIntegerList ()
 A destructor.

Static Public Member Functions

static void * create (void)
static Base::Type getClassTypeId (void)
static void init (void)

Detailed Description

Integer list properties.

Definition at line 253 of file PropertyStandard.h.


Constructor & Destructor Documentation

PropertyIntegerList::PropertyIntegerList (  ) 

A constructor.

A more elaborate description of the constructor.

Definition at line 599 of file PropertyStandard.cpp.

Referenced by Copy().

PropertyIntegerList::~PropertyIntegerList (  ) 

A destructor.

A more elaborate description of the destructor.

Definition at line 604 of file PropertyStandard.cpp.


Member Function Documentation

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

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

Implements App::Property.

Definition at line 703 of file PropertyStandard.cpp.

References draftTools::p, and PropertyIntegerList().

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

Reimplemented from App::PropertyLists.

Definition at line 593 of file PropertyStandard.cpp.

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

Reimplemented from App::PropertyLists.

Definition at line 593 of file PropertyStandard.cpp.

unsigned int PropertyIntegerList::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 717 of file PropertyStandard.cpp.

References Py::long.

PyObject * PropertyIntegerList::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 637 of file PropertyStandard.cpp.

References getSize().

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

Implements App::PropertyLists.

Definition at line 614 of file PropertyStandard.cpp.

Referenced by getPyObject(), and Save().

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

Reimplemented from App::PropertyLists.

Definition at line 593 of file PropertyStandard.cpp.

const std::vector<long>& App::PropertyIntegerList::getValues ( void   )  const [inline]

Definition at line 284 of file PropertyStandard.h.

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

Reimplemented from App::PropertyLists.

Definition at line 593 of file PropertyStandard.cpp.

long App::PropertyIntegerList::operator[] ( const int  idx  )  const [inline]

index operator

Definition at line 279 of file PropertyStandard.h.

void PropertyIntegerList::Paste ( const Property from  )  [virtual]
void PropertyIntegerList::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 684 of file PropertyStandard.cpp.

References RobotExampleTrajectoryOutOfShapes::count, Base::XMLReader::getAttributeAsInteger(), Base::XMLReader::readElement(), Base::XMLReader::readEndElement(), and setValues().

void PropertyIntegerList::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 674 of file PropertyStandard.cpp.

References Base::Writer::decInd(), getSize(), Base::Writer::incInd(), Base::Writer::ind(), and Base::Writer::Stream().

void App::PropertyIntegerList::set1Value ( const int  idx,
long  value 
) [inline]

Definition at line 281 of file PropertyStandard.h.

void PropertyIntegerList::setPyObject ( PyObject value  )  [virtual]

Reimplemented from Base::BaseClass.

Definition at line 645 of file PropertyStandard.cpp.

References draftlibs::dxfReader::error(), setValue(), and setValues().

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

Implements App::PropertyLists.

Definition at line 609 of file PropertyStandard.cpp.

void PropertyIntegerList::setValue ( long  lValue  ) 

Sets the property.

Definition at line 622 of file PropertyStandard.cpp.

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

Referenced by setPyObject().

void PropertyIntegerList::setValues ( const std::vector< long > &  values  ) 

Definition at line 630 of file PropertyStandard.cpp.

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

Referenced by Restore(), and setPyObject().


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

Generated on Wed Nov 23 19:01:44 2011 for FreeCAD by  doxygen 1.6.1