HOM/HOM_DopData.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_DopData_h__
#define __HOM_DopData_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Module.h"
#include "HOM_Errors.h"
#include "HOM_IterableList.h"
#include <string>
#include <vector>

class HOM_DopSimulation;
class HOM_DopRecord;

SWIGOUT(%rename(DopData) HOM_DopData;)

class HOM_API HOM_DopData
{
public:
    HOM_DopData()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_DopData(const HOM_DopData &data)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_DopData()
    { 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_DopData *data)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool operator!=(HOM_DopData *data)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual int __hash__() throw(HOM_Error) = 0;
    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;
    SWIGOUT(%newobject creator;)
    virtual HOM_Node *creator()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string id()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string dataType()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "recordTypes(self) -> tuple of strings") recordTypes;)
    virtual std::vector<std::string> recordTypes()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject record;)
    virtual HOM_DopRecord *record(const char *record_type, int record_index = 0)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "records(self) -> tuple of DopRecords") records;)
    SWIGOUT(%newobject records;)
    virtual HOM_IterableList<HOM_DopRecord> *records(const char *record_type)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

    SWIGOUT(%newobject options;)
    virtual HOM_DopRecord *options()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "subData(self) -> dict of strings to DopDatas") subData;)
    SWIGOUT(%newobject subData;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_DopData> > subData()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject findSubData;)
    virtual HOM_DopData *findSubData(const char *data_spec)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "findAllSubData(self, data_spec, recurse=False) -> dict")
        findAllSubData;)
    SWIGOUT(%kwargs findAllSubData;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_DopData> >
        findAllSubData(const char *data_spec, bool recurse=false)
            throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;


    SWIGOUT(%kwargs createSubData;)
    virtual HOM_DopData *createSubData(
            const char *data_name, const char *data_type,
            bool avoid_name_collisions=false)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_PermissionError,
            HOM_TypeError, HOM_Error) = 0;

    SWIGOUT(%kwargs attachSubData;)
    virtual void attachSubData(
            HOM_DopData &hom_new_subdata, const char *new_data_name,
            bool avoid_name_collisions=false)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_PermissionError,
            HOM_TypeError, HOM_Error) = 0;

    virtual void removeSubData(const char *data_spec)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_PermissionError,
            HOM_TypeError, HOM_Error) = 0;

    virtual void copyContentsFrom(HOM_DopData &hom_data)
        throw(HOM_ObjectWasDeleted, HOM_PermissionError, HOM_Error) = 0;
};

#endif

---