include/vrfExtProtocol/ifVrfObjDeltd.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: ifVrfObjDeltd.h,v $ $Revision: 1.7 $ $State: Exp $
*******************************************************************************/

#ifndef DtIfVrfObjectDeleted_H_
#define DtIfVrfObjectDeleted_H_

#include <vrfExtProtocol/ifaceCont.h>
#include <vlutil/vlString.h>
#include <vl/hostStructs.h>
#include <vlpi/NetStructs.h>

// This is the *FIXED* length portion of a DtIfVrfObjectDeleted message
// content when placed on the network.
struct DtNetIfVrfObjectDeleted
{
   DtNetEntityIdentifier        myObjectIdentifier;// 48
};                           // Total:                48 bytes

// class DtIfVrfObjectDeleted:
//
// Instances of DtIfVrfObjectDeleted are the message content for vrf object
// deleted messages.  These messages are sent by the vrf process responsible
// for locally simulating the object to be deleted.  The message indicates
// that all other vrf processes should delete their remote version of
// the this object.
// 
// Content-Type:  DtVrfObjectDeletedMessageType
// 
#include <vrfExtProtocol/vrfExtProtocolDefines.h>
class DT_DLL_vrfExtProtocol DtIfVrfObjectDeleted : public DtSimInterfaceContent
{
public:

   // default constructor
   DtIfVrfObjectDeleted();

   // destructor
   virtual ~DtIfVrfObjectDeleted();

   // copy constructor
   DtIfVrfObjectDeleted(const DtIfVrfObjectDeleted& orig);

   // assignment operator
   DtIfVrfObjectDeleted& operator=(const DtIfVrfObjectDeleted& orig);

   // Returns a newly created instance of a DtIfVrfObjectDeleted.
   virtual DtSimInterfaceContent * clone() const;

   // Returns the string type of message, DtDeleteVrfObjectMessageType (defined
   // in msgTypes.h).
   virtual int type() const;

   // Set/get the object identifier (site:app:object id) of the vrf object.
   // Corresponds to entity identifier for individual entities, aggregate Id
   // for aggregates, and object identifier for environmental process objects.
   virtual void setObjectIdentifier(const DtEntityIdentifier & objectIdentifier);
   virtual const DtEntityIdentifier & objectIdentifier() const;

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

   virtual void printDataToString(DtString& str);

   static DtSimInterfaceContent* creator();

protected:

   DtEntityIdentifier         myObjectIdentifier;
};

#endif