simInterfaceContent.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: ifaceCont.h,v $ $Revision: 1.10 $ $State: Exp $
*******************************************************************************/

//
// File:        ifaceCont.h
//
// Class:       DtSimInterfaceContent
//


#ifndef DtSimInterfaceContent_H_
#define DtSimInterfaceContent_H_

#include <vlutil/vlString.h>
#include <vrfExtProtocol/interfaceContentFactory.h>

//
// DtSimInterfaceContent is an abstract base class from which real interface
// content can be derived.  Interface content is the request, response, or other
// information provided in an interface message.
//
// All classes derived from DtSimInterfaceContent must implement a type() 
// function that returns the type of the interface content as an integer, such as 
// DtCreate-EntityMessageType or DtPauseControlType. 
// These are defined in msgTypes.h. 
// Derived classes must also provide a clone() function that copies their contents. 
// 
// Content-Type:  Not applicable.
// 
// Parameters: type - The type of interface content, such as "create-entity" or 
// "pause".

#include <vrfExtProtocol/vrfExtProtocolDefines.h>

// Function for converting content types into strings.
typedef const char* (*DtSimInterfaceContentTypePrinterFcn)(int type);

class DT_DLL_vrfExtProtocol DtSimInterfaceContent
{
protected:
   // constructors are protected because no one should instantiate the
   // base class, just derived versions.

   // default constructor
   DtSimInterfaceContent();

   // copy constructor; nothing to be copied. Here to thwart over-ambitious
   // compilers that create one when it shouldn't.
   DtSimInterfaceContent(const DtSimInterfaceContent & orig);

   // assignment operator; same as copy costructor
   const DtSimInterfaceContent & operator=(const DtSimInterfaceContent & orig);

public:
   virtual ~DtSimInterfaceContent();

   // Returns the type of Interface Content, such as "create-entity" or "pause".
   virtual int type() const = 0;

   virtual DtSimInterfaceContent * clone() const = 0;

   // Like operator = except it return true if the target data was changed.
   // Object makes a copy of data and does not take on management, caller is 
   // responsible for deletion.
   virtual bool update (const DtSimInterfaceContent* data);

   virtual char* netRep();

   virtual int netRepSize() const { return 0; }

   virtual bool setFromNet(const char* contentBuffer,
      unsigned contentSize)
       { (void) &contentBuffer; (void) &contentSize;
       return false; }

   virtual bool setToNet() { return false; }

   // Print content type
   virtual void printContentType(DtString& str);

   // Print message data
   virtual void printDataToString(DtString& str);

   // Indicate whether the interface content should be 
   // sent with the sender's session ID.  If this value
   // is set to true, only those receivers that have the
   // same session ID as the sender will read the message.
   // If the value is set the false, every receiver will
   // read the message, regardless of their session ID.
   // Currently, only DtVrfObjectDataType messages set
   // useSessionId to false.

   virtual void setUseSessionId(bool yesNo);
   virtual bool useSessionId() const;

public:
   //
   // Static functions
   //

   static DtSimInterfaceContent* createInterfaceContent(int type);

   static void addInterfaceContentCreatorFcn(int type,
      DtInterfaceContentCreatorFcn fcn);

   static void setFactory(DtInterfaceContentFactory* factory);

   static DtInterfaceContentFactory* factory();

   // Registers a function to convert content type to strings.
   // Used by printContentType(). If not set, the integer value
   // will be printed.
   static void registerContentTypePrinter(DtSimInterfaceContentTypePrinterFcn printFcn);

protected:
   virtual char* createNetworkBuffer();

protected:
   char*                              myNetRep;
   bool                          myUseSessionId;

protected:

   static DtInterfaceContentFactory*  myFactory;

   static DtSimInterfaceContentTypePrinterFcn theContentTypePrinterFcn;
};


#endif