gzDistEvent.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistEvent.h
// Module       : gzDistribution
// Description  : Definition of a gzDistEvent
// Author       : Christian Andersson, Anders Sandblad  
// 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  031021  Created file    
//
//******************************************************************************
#ifndef __GZ_DIST_EVENT_H__
#define __GZ_DIST_EVENT_H__

// Includes
#include "gzDistBase.h"
#include "gzDistAttribute.h"

//******************************************************************************
// Class    : gzDistEvent
//                                  
// Purpose  : The base definition class of a distribution event.
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// CAN  031021  Created 
//                                  
//******************************************************************************

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistEvent, GZ_DIST_EXPORT);


class gzDistEvent : public gzDistThreadSafeReference
{
    friend class gzDistSession;
    friend class gzDistEventAttributeIterator;

    public:

        GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_DIST_EXPORT);

        GZ_DIST_EXPORT gzDistEvent();

        /*  \param event    The event that will be copied.*/
        GZ_DIST_EXPORT gzDistEvent(const gzDistEvent& event);

        GZ_DIST_EXPORT virtual ~gzDistEvent();


        GZ_DIST_EXPORT gzDouble getAttributeNumber(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeNumber(const gzString& attributeName, gzDouble& number) const;


        GZ_DIST_EXPORT gzString getAttributeString(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeString(const gzString& attributeName, gzString& string) const;


        GZ_DIST_EXPORT gzGUID getAttributeGuid(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeGuid(const gzString& attributeName, gzGUID& guid) const;


        GZ_DIST_EXPORT const gzDynamicType& getAttributeValue(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeValue(const gzString& attributeName, gzDynamicType& value) const;


        GZ_DIST_EXPORT gzVoid setAttributeValue(const gzString& attributeName, const gzDynamicType& value);


        GZ_DIST_EXPORT gzBool hasAttribute(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool removeAttribute(const gzString& attributeName);
        

        GZ_DIST_EXPORT gzDistSession* getSession() const;


        GZ_DIST_EXPORT virtual gzReference* clone() const;


        GZ_DIST_EXPORT gzBool store(gzSerializeAdapter* adapter);


        GZ_DIST_EXPORT gzBool restore(gzSerializeAdapter* adapter);


        GZ_DIST_EXPORT gzVoid setHighPriority();


        GZ_DIST_EXPORT gzBool isHighPriority() const;


        GZ_DIST_EXPORT gzVoid clear();


        GZ_DIST_EXPORT gzVoid setDestination(const gzDistInstanceID& destination);


        GZ_DIST_EXPORT const gzDistInstanceID& getDestination() const;


        GZ_DIST_EXPORT gzUInt getDataSize() const;

    private:

        gzVoid setSession(gzDistSession* session);

        gzVoid setAttribute(gzDistEventAttribute* attribute);
        
    // Members:

        // For directed events
        gzDistInstanceID m_destination;

        mutable gzDict<gzString, gzDistEventAttribute> m_attributes;

        gzDistSession* m_session;

        gzBool m_highPrio;
};


//-------------------------- gzDistEventAttributeIterator --------------------

//*****************************************************************************
// Class    : gzDistEventAttributeIterator
//                                  
// Purpose  : Iterator for event attributes
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//
// Who  Date    Description                     
//                                  
// CAN  031021  Created 
//                                  
//*****************************************************************************
class gzDistEventAttributeIterator
{
    public:


        GZ_DIST_EXPORT gzDistEventAttributeIterator(const gzDistEventPtr& object);
        
        GZ_DIST_EXPORT ~gzDistEventAttributeIterator();


        GZ_DIST_EXPORT gzBool operator()();

        GZ_DIST_EXPORT const gzDistAttribute& current() const;

        GZ_DIST_EXPORT const gzDistAttribute* operator->() const;

        GZ_DIST_EXPORT gzVoid reset();

    private:

        const gzDistEventPtr m_event;
        gzDictIterator<gzString, gzDistEventAttribute> m_iterator;
        gzDictEntry<gzString, gzDistEventAttribute>* m_entry;
};

#endif

---