vos/metaobjects/policy/hostedavatar.hh

Go to the documentation of this file.

/* $Id: hostedavatar.hh,v 1.5 2003/07/24 05:18:18 tetron Exp $ */


/** @file hostedAvatar.hh Defines MetaObject class for "policy:hostedAvatar" object type (revision 0). */

/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges
 * <reed@zerohour.net> and Peter Amstutz <tetron@interreality.org>
 *
 * Search for TODO for stuff that needs editing. You will want to especially fill
 * in constructors, destructors, message handlers, non-property subobjects...
 *
 * The authors of otd2cpp make no guarantee that this code will work, or even
 * that it even is safe to run.  Use it at your own risk.
 */

#ifndef _POLICY_HOSTEDAVATAR_HH_
#define _POLICY_HOSTEDAVATAR_HH_


#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef POLICY_EXPORTS
#  define POLICY_API __declspec(dllexport)
# else
#  define POLICY_API __declspec(dllimport)
# endif
#else
# define POLICY_API
#endif

class POLICY_API HostedAvatarAccessControl
{
public:
    virtual ~HostedAvatarAccessControl() { };
    virtual bool checkRequestAvatarPermission(Vobject& requester, Vobject* suppliedavatar) = 0;
};

class POLICY_API NoHostedAvatarAccessControl : public HostedAvatarAccessControl
{
public:
    static NoHostedAvatarAccessControl static_;
    virtual ~NoHostedAvatarAccessControl() { };
    virtual bool checkRequestAvatarPermission(Vobject& requester, Vobject* suppliedavatar) { return true; }
};

/** MetaObject implementing HostedAvatar Object Type.

        Indended to be used by virtual worlds and other vobjects where there is a possibility for

*/

class POLICY_API HostedAvatar : public virtual MetaObject {

protected:
    PropertyAccessControl* accessControl;


public:

    /** Constructor */
    HostedAvatar(MetaObject* superobject);

    /** Destructor */
    virtual ~HostedAvatar();

    /** Return type string ("policy:hostedAvatar") */
    virtual const string getType();

    /** Register Extenders */
    static void registerExtenders();

    /** Set default access control policy */
    virtual void setPropertyAccessControl(PropertyAccessControl* ac);

    /** Get default access control policy */
    virtual PropertyAccessControl* getPropertyAccessControl();

    /** @name Access Subobjects */
    //@{

    /** Get the value of policy:hosted-avatar-is-required property (Whether using a hosted avatar is required to use this world, or
            merely optional (datatype is text/x-yes-or-no) .). */
    virtual string getHostedAvatarIsRequired();

    /** Get the datatype of policy:hosted-avatar-is-required property. */
    virtual string getHostedAvatarIsRequiredDatatype();

    /** Set policy:hosted-avatar-is-required property.
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used.
    */
    virtual void setHostedAvatarIsRequired(const string& value, const string& datatype = "?", PropertyAccessControl* ac = NULL);

    /** Get the policy:hosted-avatar-is-required object. */
    virtual Vobject* getHostedAvatarIsRequiredObject();

    /** Set the policy:hosted-avatar-is-required object.
        @param newobj   The new subobject. */
    virtual void setHostedAvatarIsRequiredObject(Vobject* newobj);

    //@}


    /** @name Actuators. User-functions that correspond to
message actions. */
    //@{

    /** Perform request-avatar. (Request an avatar to be created on the remote server, possiblyfollowing the template described by "myavatar".) */
    virtual Vobject& doRequestAvatar(Vobject* myavatar) = 0;

    //@}
};

/** Local version of HostedAvatar. */

class POLICY_API LocalHostedAvatar : public virtual HostedAvatar {
protected:
    HostedAvatarAccessControl* hostedavatarAC;
public:

    /** Constructor */
    LocalHostedAvatar(MetaObject* superobject);

    /** Destructor */
    ~LocalHostedAvatar();

    /** Initialize required subproperties with given access control. */
    virtual void initialize(PropertyAccessControl* ac);

    /** Initialize required subproperties. If access control has been
        previously set with initialize(PropertyAccessControl*) or
        setPropertyAccessControl(), then that policy will be used. Otherwise,
        NoPropertyAccessControl will be used.
    */
    virtual void initialize();

    /** Static generator, for factory. */
    static MetaObject* new_LocalHostedAvatar(MetaObject* superobject, const string& type);

    /**  @name Actuators. These methods correspond to messages. */
    //@{

    /** Perform request-avatar. (Request an avatar to be created on the remote server, possiblyfollowing the template described by "myavatar".) */
    virtual Vobject& doRequestAvatar(Vobject* myavatar);

    //@}

    virtual void setHostedAvatarAccessControl(HostedAvatarAccessControl* haac) { hostedavatarAC = haac; }
    virtual HostedAvatarAccessControl* getHostedAvatarAccessControl() { return hostedavatarAC; }

protected:

    /** @name Message Handlers */
    //@{

    /** Handle message request-avatar (Request an avatar to be created on the remote server, possiblyfollowing the template described by "myavatar".) */
    virtual void handleRequestAvatar(Message* m);

    //@}


};

/** Remote proxy for HostedAvatar */

class POLICY_API RemoteHostedAvatar : public virtual HostedAvatar {

public:

    /** Constructor */
    RemoteHostedAvatar(MetaObject* superobject);

    /** Destructor */
    virtual ~RemoteHostedAvatar();

    /** Static generator, for factory. */
    static MetaObject* new_RemoteHostedAvatar(MetaObject* superobject, const string& type);

    /** @name Actuators.
        These are user-functions corresponding to messages. The remote actuators marshal arguments and send a message to the Local object. */
    //@{
    /** Send a request-avatar messsage to the local object. */
    virtual Vobject& doRequestAvatar(Vobject* myavatar);


    //@}


protected:

    /** @name Update Handlers. Handlers for remote update messages */
    //@{

    /** Handle a request-avatar-reply messsage from the local object. */
    virtual void handleRequestAvatarReply(Message* m);

    //@}

};


#endif // #ifndef _POLICY_HOSTEDAVATAR_HH_

---