HOM/HOM_DopNode.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_DopNode_h__
#define __HOM_DopNode_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Node.h"
#include <vector>

class HOM_DopData;
class HOM_DopNetNode;
class HOM_DopSimulation;

SWIGOUT(%rename(DopNode) HOM_DopNode;)

class HOM_API HOM_DopNode : virtual public HOM_Node
{
public:
    HOM_DopNode()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_DopNode(const HOM_DopNode &dop_node)
    : HOM_Node(dop_node)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_DopNode()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig know we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;)

    SWIGOUT(%newobject dopNetNode;)
    virtual HOM_Node *dopNetNode()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject simulation;)
    virtual HOM_DopSimulation *simulation()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "processedObjects(self) -> tuple of DopDatas")
        processedObjects;)
    virtual std::vector<HOM_ElemPtr<HOM_DopData> > processedObjects()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "createdObjects(self) -> tuple of DopDatas")
        createdObjects;)
    virtual std::vector<HOM_ElemPtr<HOM_DopData> > createdObjects()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool isBypassed()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void bypass(bool on)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool isDisplayFlagSet()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setDisplayFlag(bool on)
        throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject displayNode;)
    virtual HOM_Node *displayNode()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "objectsToProcess(self) -> tuple of DopDatas")
        objectsToProcess;)
    virtual std::vector<HOM_ElemPtr<HOM_DopData> > objectsToProcess()
        throw(HOM_ObjectWasDeleted, HOM_PermissionError, HOM_Error) = 0;
};

#endif

---