HOM/HOM_NodeGroup.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_NodeGroup_h__
#define __HOM_NodeGroup_h__

#include "HOM_API.h"
#include "HOM_Module.h"
#include "HOM_Errors.h"
#include <string>

class HOM_Node;

SWIGOUT(%rename(NodeGroup) HOM_NodeGroup;)

class HOM_API HOM_NodeGroup
{
public:
    HOM_NodeGroup()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_NodeGroup(const HOM_NodeGroup &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_NodeGroup()
    { HOM_DESTRUCT_OBJECT(this) }

    // We compare against a pointer instead of a reference because we want
    // to be able to compare against None.
    virtual bool operator==(HOM_NodeGroup* node_group)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool operator!=(HOM_NodeGroup* node_group)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string __repr__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string name()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

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

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

    virtual void addNode(HOM_Node &node)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    virtual void removeNode(HOM_Node &node)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    virtual void clear()
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    virtual void destroy()
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%kwargs asCode;)
    virtual std::string asCode(
            bool save_creation_commands=true, 
            bool save_node_memberships=true,
            const char *function_name=NULL)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;
};

#endif

---