pEmitterSystemObject.h

Go to the documentation of this file.

/******************************************************************************
 ** Copyright (c) 1992-2010 VT MAK
******************************************************************************/


#ifndef pEmitterSystemObject_H_
#define pEmitterSystemObject_H_


#include <portal/pEmbeddedSystem.h> //DtPortalEmbeddedSystem

namespace MAKVrExchange {

class DT_DLL_LIBPORTAL DtPortalEmitterSystemObject : public DtPortalEmbeddedSystem
{
public:

   DtPortalEmitterSystemObject();

   virtual ~DtPortalEmitterSystemObject();

   DtPortalEmitterSystemObject( const DtPortalEmitterSystemObject& original );

   DtPortalEmitterSystemObject& operator=( const DtPortalEmitterSystemObject& original );

   int operator==( const DtPortalEmitterSystemObject& rightOperand ) const;

   int operator!=( const DtPortalEmitterSystemObject& rightOperand ) const;

   //Doxygen comments inherited from parent class
   virtual const char* objectKindName() const;

   //Doxygen comments inherited from parent class
   virtual unsigned int netSize() const;

   // self reference
   virtual DtPortalEmitterSystemObject* self() const;

   //Doxygen comments inherited from parent class
   virtual void writeSelfToBuffer( void* buffer ) const ;

   //Doxygen comments inherited from parent class
   virtual void readSelfFromBuffer(const void* buffer);

   //Doxygen comments inherited from parent class
   virtual std::ostream& printDataToStream( std::ostream& stream ) const;

   //Doxygen comments inherited from parent class
   static DtPortalMessage* create();

   static const DtPortalMessageKind theKind;

   //Doxygen comments inherited from parent class
   virtual DtPortalMessageKind kind() const;


   DtDEC_ATTRIBUTE( DtU32, EmitterType, emitterType );

   DtDEC_ATTRIBUTE( DtU32, EmitterFunctionCode, emitterFunctionCode );

   DtDEC_ATTRIBUTE( DtU32, EmitterIndex, emitterIndex );

   DtDEC_ATTRIBUTE( DtString, EventIdentifier, eventIdentifier );

   DtDEC_ATTRIBUTE( DtEmitterBeamList, EmitterBeamList, emitterBeamList );


public:
   bool isBeamWithinList( DtU8 beamId ) const;
   DtEmitterBeamData* findBeam( DtU8 beamId );
   const DtEmitterBeamData* findBeam( DtU8 beamId ) const;

private:

}; //end class DtPortalEmitterSystemObject

inline DtPortalMessage* DtPortalEmitterSystemObject::create()
{
   return new DtPortalEmitterSystemObject();
}

inline const char* DtPortalEmitterSystemObject::objectKindName() const
{
   return "Emitter System";
}

inline DtPortalMessageKind DtPortalEmitterSystemObject::kind() const
{
   return theKind;
}

}

#endif //end #ifndef pEmitterSystemObject_H_