gzDistAttribute.h

//*****************************************************************************
// File         : gzDistAttribute.h
// Module       : gzDistribution
// Description  : Declaration of attributes in gzDistEvent and gzDistObject
// Author       : Christian Andersson
// Product      : GizmoDistribution 2.1.1
//      
// Copyright © 2004 - Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoDistribution is a toolkit used for implementing distributed 
//          objects and events in C++
//
//
// Revision History...
//                                  
// Who  Date    Description                     
//                                  
// CAN  040113  Created file    
//
//*****************************************************************************
#ifndef __GZ_DIST_ATTRIBUTE_H__
#define __GZ_DIST_ATTRIBUTE_H__

// Includes
#include "gzDistBase.h"

// Forward declarations.
class gzDistClientInterface;

//---------------------------- gzDistAttribute --------------------------------

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistAttribute, GZ_DIST_EXPORT);


class gzDistAttribute GZ_DIST_MEMBASE_SINGLE(gzDistAttribute)
{
    public:

        GZ_DIST_MEMBASE_IMP(gzDistAttribute);

        GZ_DIST_MEMBASE_CALL(gzDistAttribute);

        GZ_DIST_EXPORT gzDistAttribute(const gzString& name);

        GZ_DIST_EXPORT gzDistAttribute(const gzString& name, const gzDynamicType& value);

        GZ_DIST_EXPORT gzDistAttribute(const gzDistAttribute& attribute);

        GZ_DIST_EXPORT virtual ~gzDistAttribute();

        GZ_DIST_EXPORT const gzString& getName() const;
        
        GZ_DIST_EXPORT const gzDynamicType& getValue() const;

        GZ_DIST_EXPORT gzBool store(gzSerializeAdapter* adapter);

        GZ_DIST_EXPORT gzBool restore(gzSerializeAdapter* adapter);
    

//  private:

        gzULong getDataSize() const;

        gzDistAttribute(){}

        // The attribute value
        gzDynamicType value;

        // The name of the attribute
        gzSerializeString name;
};

//-------------------------- gzDistObjectAttribute -----------------------------

// Internal object attribute class
class gzDistObjectAttribute : public gzDistThreadSafeReference
{
    friend class gzDistObject;
    friend class gzDistSession;

    public:

        // Constructor
        GZ_DIST_EXPORT gzDistObjectAttribute(const gzString& name, gzDistObject* parent);

        // Constructor
        GZ_DIST_EXPORT gzDistObjectAttribute(const gzString& name, const gzDynamicType& value, gzDistObject* parent);

        // Copy constructor
        GZ_DIST_EXPORT gzDistObjectAttribute(const gzDistObjectAttribute& attribute);

        // Destructor
        GZ_DIST_EXPORT virtual ~gzDistObjectAttribute();

        // Clone the attribute
        GZ_DIST_EXPORT virtual gzReference* clone() const;

        // Get the name of the attribute
        const gzString& getName() const;

        // For internal use only
        const gzDistAttribute& attribute() const;

    private:

        // Get the attribute value
        gzDynamicType getValue() const;

        // Get the attribute value
        gzVoid getValue(gzDynamicType& value) const;

        // Get the type of the attribute value
        const gzString& getDynamicType() const;

        // Get the number in the attribute value
        gzDouble getNumber() const;

        // Get the value as GUID
        gzGUID getGuid() const;

        // Get the value as GUID
        gzVoid getGuid(gzGUID& guid) const;

        // Get the string in the attribute value
        gzVoid getString(gzString& string) const;

        // Get a ref pointer to the referenced object in attribute value
        gzVoid getReference(gzRefPointer<gzReference>& reference) const;

        // Get the pointer in attribute value
        gzVoid* getPointer() const;

        // Serialize attribute including owners to adapter.
        gzBool store(gzSerializeAdapter* adapter);

        // Serialize adapter data (including owners) to attribute.
        gzBool restore(gzSerializeAdapter* adapter);

        // Constructor used in serialisazion.
        gzDistObjectAttribute(gzDistObject* parent);

        // Get the object containing this attribute
        gzDistObject* getObject();

        // Check if the client is a subscriber of this attribute.
        gzBool isSubscriber(gzDistClientInterface* client) const;

        // Set the attribute value
        gzVoid setValue(const gzDynamicType& value);

        // Subscribe of instance of the attribute in the obejct
        gzBool subscribe(gzDistClientInterface* client);

        // Unsubscribe of instance of the attribute in the obejct
        gzBool unsubscribe(gzDistClientInterface* client);

        // Remove all attribute subscribers
        gzVoid removeSubscribers();

        // Remove all references to client.
        // Returns TRUE if client was owner of attribute.
        gzBool resign(gzDistClientInterface* client);

        // Set the owner off attribute independent of requests.
        // If the new owner exist in request queue it will be removed.
        gzVoid setOwner(const gzDistClientID& owner);

        // Get the owner of the attribute. If no owner, a null-instance will be returned.
        const gzDistClientID& getOwner();

        // Set next requesting owner.
        gzVoid setNextOwner();

        // Returns TRUE if client is owner.
        gzBool isOwner(const gzDistClientID& clientId) const;

        // Returns TRUE if client is requesting the ownership.
        gzBool isOwnershipRequester(const gzDistClientID& clientId) const;

        // Puts the client in request queue for ownership.
        // If no owner, client will be owner.
        // Returns owner after request.
        const gzDistClientID& requestOwnership(const gzDistClientID& clientId);

        // Returns first entry in gzDistOwnerData::m_ownerRequests if exist.
        gzDistClientID* getNextOwnerRequester();

        // Remove client from ownership request queue.
        gzBool removeOwnershipRequest(const gzDistClientID& clientId);

        // Checks if there is another owner than client.
        // The method returns TRUE if the attribute is "un-owned" or owned by the client, otherwise FALSE.
        gzBool isAllowedToUpdate(const gzDistClientID& clientId);

        // Release all references to object, clients etc.       
        gzVoid release();

        // Clear all ownership requests.
        // If 'destroy' is FALSE, the items will not be deleted, only removed.
        gzVoid clearOwnershipRequests(gzBool destroy = TRUE);

        // Clean up all ownership etc. referring to instance.
        gzVoid cleanUpInstance(const gzDistInstanceID& instance);

    // Members:

        // A list containing all subscribers of this attribute.
        gzList<gzDistClientInterface> m_subscribers;

        // The owner of the attribute
        struct gzDistOwnerData
        {
            gzDistClientID m_owner;
            gzList<gzDistClientID> m_ownerRequests;

        }* m_ownerData;
        
        // A pointer to the owner object.
        gzDistObject* m_parent;

        // The attribute
        gzDistAttribute m_attribute;
};


//-------------------------- gzDistEventAttribute ------------------------------

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistEventAttribute, GZ_DIST_EXPORT);

// Internal event attribute class
class gzDistEventAttribute GZ_DIST_MEMBASE_SINGLE(gzDistEventAttribute)
{
    friend class gzDistEvent;

    public:

        GZ_DIST_MEMBASE_IMP(gzDistEventAttribute);

        GZ_DIST_MEMBASE_CALL(gzDistEventAttribute);

        // Constructor
        GZ_DIST_EXPORT gzDistEventAttribute(const gzString& name, const gzDynamicType& value);

        // Constructor
        GZ_DIST_EXPORT gzDistEventAttribute(const gzDistAttribute& data);

        // Constructor that takes name and value from the gzDistObjectAttribute
        GZ_DIST_EXPORT gzDistEventAttribute(gzDistObjectAttribute* objectAttribute);

        // Constructor that takes the value from the gzDistObjectAttribute
        GZ_DIST_EXPORT gzDistEventAttribute(const gzString& name, gzDistEventAttribute* objectAttribute);

        // Copy constructor
        GZ_DIST_EXPORT gzDistEventAttribute(const gzDistEventAttribute& attribute);

        // Destructor
        GZ_DIST_EXPORT virtual ~gzDistEventAttribute();

        // For internal use only
        const gzDistAttribute& attribute() const;

    private:

        gzDistEventAttribute();

        // Get the name of the attribute
        const gzString& getName() const;        

        // Get the value as number
        gzDouble getNumber() const;

        // Get the value as string
        gzVoid getString(gzString& string) const;

        // Get the value as GUID
        gzGUID getGuid() const;

        // Get the value as GUID
        gzVoid getGuid(gzGUID& guid) const;

        // Get the value as string
        gzString getString() const;

        // Get the type
        const gzString& getDynamicType() const;

        // Serialize attribute to adapter.
        gzBool store(gzSerializeAdapter* adapter);

        // Serialize adapter data to attribute.
        gzBool restore(gzSerializeAdapter* adapter);

        gzVoid setValue(const gzDynamicType& value);

    // Members:

        gzDistAttribute m_attribute;
};


#endif

---