include/vrfmsgs/ifPluginData.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: ifPluginData.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/




#ifndef ifPluginData_H_
#define ifPluginData_H_

#include <vlutil/vlString.h>
#include <vrfExtProtocol/ifaceCont.h>
#include <vlutil/vlNetTypes.h>

#include <vector>

#include "vrfmsgs/vrfmsgsDefines.h"

class DT_DLL_vrfmsgs DtVrfMessagePluginInformation
{
public:
   DtVrfMessagePluginInformation();

   int size() const;
   const char* setFromNet(const char* buffer);
   char* setToNet(char* buffer);
   void printDataToString(DtString&);

   std::string    pluginName;
   std::string    pluginVersion;
   std::string    pluginDescription;
   std::string    pluginCreator;
   std::string    pluginCreatorEmail;
   std::string    pluginContactWebPage;
   std::string    pluginContactMailingAddress;
   std::string    pluginContactPhone;
};

class DT_DLL_vrfmsgs DtIfPluginData : public DtSimInterfaceContent
{

public:
   DtIfPluginData();

   DtIfPluginData(const DtIfPluginData & orig);

   const DtIfPluginData & operator=(const DtIfPluginData & orig);

   virtual ~DtIfPluginData();

   virtual int type() const;

   virtual DtSimInterfaceContent * clone() const;

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* contentBuffer, 
      unsigned contentSize);

   virtual bool setToNet();

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

   const std::vector<DtVrfMessagePluginInformation>& pluginInformation() const;

   virtual void addPluginInformation(const DtVrfMessagePluginInformation&);

   void setRequestId(unsigned int);
   unsigned int requestId() const;

protected:
   DtNetU32 myRequestId;
   std::vector<DtVrfMessagePluginInformation>   myPluginInformationList;
};

inline const std::vector<DtVrfMessagePluginInformation>& DtIfPluginData::pluginInformation() const
{
   return myPluginInformationList;
}

inline void DtIfPluginData::setRequestId(unsigned int i)
{
   myRequestId = i;
}

inline unsigned int DtIfPluginData::requestId() const
{
   return myRequestId;
}

#endif