Robot::TrajectoryObject Class Reference

#include <TrajectoryObject.h>

Inheritance diagram for Robot::TrajectoryObject:
App::GeoFeature App::DocumentObject App::PropertyContainer Base::Persistence Base::BaseClass Robot::Edge2TracObject Robot::TrajectoryCompound Robot::TrajectoryDressUpObject

List of all members.

Public Member Functions

virtual
App::DocumentObjectExecReturn
execute (void)
 get called by the document to recompute this feature Normaly this method get called in the processing of Document::recompute().
virtual PyObjectgetPyObject (void)
 This method returns the Python wrapper for a C++ object.
virtual Base::Type getTypeId (void) const
virtual const char * getViewProviderName (void) const
 returns the type name of the ViewProvider
virtual short mustExecute (void) const
 mustExecute We call this method to check if the object was modified to be invoked.
 TrajectoryObject (void)
 Constructor.
virtual ~TrajectoryObject ()

Static Public Member Functions

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

Public Attributes

App::PropertyPlacement Base
PropertyTrajectory Trajectory

Protected Member Functions

virtual const App::PropertyDatagetPropertyData (void) const
virtual void onChanged (const App::Property *prop)
 get called by the container when a property has changed

Static Protected Member Functions

static const App::PropertyDatagetPropertyDataPtr (void)

Detailed Description

Definition at line 37 of file TrajectoryObject.h.


Constructor & Destructor Documentation

TrajectoryObject::TrajectoryObject ( void   ) 

Constructor.

Definition at line 39 of file TrajectoryObject.cpp.

References ADD_PROPERTY_TYPE, and App::Prop_None.

TrajectoryObject::~TrajectoryObject (  )  [virtual]

Definition at line 47 of file TrajectoryObject.cpp.


Member Function Documentation

void * Robot::TrajectoryObject::create ( void   )  [static]
virtual App::DocumentObjectExecReturn* Robot::TrajectoryObject::execute ( void   )  [inline, virtual]

get called by the document to recompute this feature Normaly this method get called in the processing of Document::recompute().

In execute() the outpupt properties get recomputed with the data from linked objects and objects own properties.

Reimplemented from App::DocumentObject.

Reimplemented in Robot::Edge2TracObject, Robot::TrajectoryCompound, and Robot::TrajectoryDressUpObject.

Definition at line 50 of file TrajectoryObject.h.

References App::DocumentObject::StdReturn.

Base::Type Robot::TrajectoryObject::getClassTypeId ( void   )  [static]
const App::PropertyData & Robot::TrajectoryObject::getPropertyData ( void   )  const [protected, virtual]
const App::PropertyData * Robot::TrajectoryObject::getPropertyDataPtr ( void   )  [static, protected]
PyObject * TrajectoryObject::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 App::DocumentObject.

Definition at line 56 of file TrajectoryObject.cpp.

References Py::_None(), Py::Object::is(), Py::new_reference_to(), and App::DocumentObject::PythonObject.

Base::Type Robot::TrajectoryObject::getTypeId ( void   )  const [virtual]
virtual const char* Robot::TrajectoryObject::getViewProviderName ( void   )  const [inline, virtual]

returns the type name of the ViewProvider

Reimplemented from App::DocumentObject.

Reimplemented in Robot::Edge2TracObject, Robot::TrajectoryCompound, and Robot::TrajectoryDressUpObject.

Definition at line 47 of file TrajectoryObject.h.

void Robot::TrajectoryObject::init ( void   )  [static]

Reimplemented from App::PropertyContainer.

Reimplemented in Robot::Edge2TracObject, Robot::TrajectoryCompound, and Robot::TrajectoryDressUpObject.

Definition at line 36 of file TrajectoryObject.cpp.

Referenced by initRobot().

short TrajectoryObject::mustExecute ( void   )  const [virtual]

mustExecute We call this method to check if the object was modified to be invoked.

If the object label or an argument is modified. If we must recompute the object - to call the method execute(). 0: no recompution is needed 1: recompution needed -1: the document examine all links of this object and if one is touched -> recompute

Reimplemented from App::DocumentObject.

Definition at line 51 of file TrajectoryObject.cpp.

void TrajectoryObject::onChanged ( const App::Property prop  )  [protected, virtual]

get called by the container when a property has changed

Reimplemented from App::DocumentObject.

Reimplemented in Robot::Edge2TracObject, and Robot::TrajectoryDressUpObject.

Definition at line 65 of file TrajectoryObject.cpp.


Member Data Documentation

Definition at line 56 of file TrajectoryObject.h.

Referenced by RobotGui::ViewProviderTrajectory::updateData().


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

Generated on Wed Nov 23 19:02:45 2011 for FreeCAD by  doxygen 1.6.1