HOM_AgentMetadata.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.
 *
 */

#ifndef __HOM_AgentMetadata_h__
#define __HOM_AgentMetadata_h__

#include "HOM_API.h"
#include "HOM_Module.h"
#include "HOM_PtrOrNull.h"

SWIGOUT(%rename(AgentMetadata) HOM_AgentMetadata;)
// Force SWIG to output an __init__ method even though it determines this
// class is abstract.
SWIGOUT(%feature("notabstract") HOM_AgentMetadata;)

class HOM_API HOM_AgentMetadata
{
public:
#ifdef SWIG
%extend
{
    HOM_AgentMetadata(const char *path, bool keep_external_ref = true)
    { return HOM().newAgentMetadata(path, keep_external_ref); }

    HOM_AgentMetadata(
        const std::map<std::string, hboost::any> &data)
    {
        return HOM().newAgentMetadata(data);
    }
}
#else
    HOM_AgentMetadata()
    { HOM_CONSTRUCT_OBJECT(this) }
#endif

    virtual ~HOM_AgentMetadata()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual bool
    operator==(HOM_PtrOrNull<HOM_AgentMetadata> metadata) const = 0;

    bool operator!=(HOM_PtrOrNull<HOM_AgentMetadata> metadata) const
        { return !operator==(metadata); }

    virtual int __hash__() const = 0;
    virtual std::string __repr__() const = 0;

    SWIGOUT(%newobject freeze;)
    virtual HOM_AgentMetadata *freeze() const = 0;
    virtual bool isReadOnly() const = 0;

    virtual std::string asJSON() const = 0;

    SWIGOUT(%kwargs fileName;)
    virtual std::string fileName(bool expanded = false) const = 0;

    virtual std::map<std::string, hboost::any> data() const = 0;
    virtual void setData(const std::map<std::string, hboost::any> &data) = 0;
};

#endif