tenaBroker/libTenaBroker/brokerObject.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <namespace.h>

#include <vlpi/entityType.h>

#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>

namespace MAKVrExchange
{

   namespace DtTenaBroker
   {

      class DT_DLL_TENABROKER DtBrokerObject
      {
      public:

         typedef enum
         {
            none   = 0, // This is an error
            portal = 1, // This message is coming from the Portal API
            tena   = 2, // This message is coming from TENA
         } OriginatingProtocol;

      public:

         DtBrokerObject( OriginatingProtocol prot,
            const DtString& translatorName );

         virtual ~DtBrokerObject();

      public:

         virtual OriginatingProtocol protocol() const;

         virtual bool isPublishable() const;
         virtual void setIsPublishable( bool val );

         virtual bool isDiscovered() const;
         virtual void setIsDiscovered( bool val );

         virtual bool isDropped() const;
         virtual void setIsDropped( bool val );

         virtual bool isFiltered() const;
         virtual void setIsFiltered( bool val );

         virtual const DtString &translatorName() const;
         virtual void setTranslatorName( const DtString& name );

         virtual const DtString &objectName() const;
         virtual void setObjectName( const DtString& name );

         virtual const DtString &markingText() const;
         virtual void setMarkingText( const DtString& name );

         virtual const DtEntityType& entityType() const;
         virtual void setEntityType( const DtEntityType& type );

         virtual void *publisherPtr() const;
         virtual void setPublisherPtr( void* ptr );

         virtual const void *reflectedObjPtr() const;
         virtual void setReflectedObjPtr( const void* ptr );

         virtual void setLastTick( const DtTime& time );
         virtual DtTime lastTick() const;

      private:

         DtBrokerObject( const DtBrokerObject& other );

         DtBrokerObject& operator = ( const DtBrokerObject& other );

      protected:

         void *myPublisherPtr;
         const void *myReflectedObjPtr;

         bool myPublishableFlag;

         bool myDiscoveredFlag;

         bool myDroppedFlag;

         bool myFilteredFlag;

         DtTime myLastTick;

         OriginatingProtocol myProtocol;
         DtString myTranslatorName;
         DtString myStatus;
         DtString myObjectName;
         DtString myMarkingText;
         DtEntityType myEntityType;

      };

   }
}