pFruit.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 2005 VT MAK
 *********************************************************************/
#pragma once


#include <portal/pObject.h>
#include <vlutil/vlString.h>

#include <portal/pReflectedObjectManager.h>

// \brief This class represents Fruit objects. 
class DtPortalFruit: public MAKVrExchange::DtPortalObject
{

public:

   // \brief The Default CTOR.
   DtPortalFruit();

   // \brief The Default DTOR.
   virtual ~DtPortalFruit();

   // \brief The default Copy CTOR.
   DtPortalFruit(const DtPortalFruit& other);

   // \brief The default Assignment operator. 
   DtPortalFruit &operator=(const DtPortalFruit& other);

   bool operator!=(const DtPortalFruit& other) const;
   bool operator==(const DtPortalFruit& other) const;

   // \brief returns this message kind. 
   virtual MAKVrExchange::DtPortalMessageKind kind() const { return DtPortalFruit::theKind; } 

   // \brief Returns  string representation of this object kind. 
   virtual const char* objectKindName() const { return "Fruit";}


   // \brief Returns the number of bytes required to encode this class.
   virtual unsigned int netSize() const;

   // \brief Encodes class to network structure. 
   virtual void writeSelfToBuffer(void *buffer) const ;

   // \brief Decodes class from network structure. 
   virtual void readSelfFromBuffer(const void *buffer);

   // \brief Prints attributes to a stream.
   virtual std::ostream &printDataToStream(std::ostream &str) const;

   // \brief A string description of the fruit
   DtDEC_ATTRIBUTE(DtString, FruitType, FruitType);

   // \brief The location of the fruit, in geocentric coordinates.
   DtDEC_ATTRIBUTE(DtVector, Location, location);

   // \brief The sugar content as a percentage of the fruits total volume: in the range 0->100
   DtDEC_ATTRIBUTE(DtU32, SugarContent, sugarContent);

public:

   static const MAKVrExchange::DtPortalMessageKind theKind;
   static DtPortalMessage *create() { return new DtPortalFruit; }

};

// \brief Make a reflected object class. 
typedef MAKVrExchange::DtPortalReflectedObjectTemplate<DtPortalFruit> DtPortalReflectedFruit;

// \brief Make a reflected object manager class. 
typedef MAKVrExchange::DtPortalReflectedObjectManager<DtPortalReflectedFruit> DtPortalReflectedFruitManager;