lcCommand.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include "lcPdu.h"

typedef struct DtLgrCommandData
{
   DtNetInt16 domain;
   DtNetInt16 protocol;
   DtNetInt16 command;
   DtNetU16   pad1;
   DtNetU16 parametersBuffLength;
   DtNetU16 parametersBuffOffset;
} DtLgrCommandData;

const int theCommandPduSize = theLgrControlPduSizeSansParams
   + sizeof(DtLgrCommandData);

typedef const char* (*DtDomainToStringFunc)(int domain);
typedef const char* (*DtProtocolToStringFunc)(int protocol);
typedef const char* (*DtCommandToStringFunc)(int domain, int command);

class DT_DLL_LOGGERCONTROL DtLgrCommandPdu : public DtLgrControlPdu
{
public:

   DtLgrCommandPdu( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );

   DtLgrCommandPdu( const DtNetLgrControlPdu* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory* pduFactory = 0 );

   DtLgrCommandPdu( const DtEntityIdentifier& sender,
      const DtEntityIdentifier& receiver, int domain, int protocol,
      int commandId, const DtString& parametersBuffer, int pduSize=theCommandPduSize,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );

   virtual ~DtLgrCommandPdu();

   DtLgrCommandPdu( const DtLgrCommandPdu& src );

   DtLgrCommandPdu& operator=( const DtLgrCommandPdu& src );

   //@(
   virtual int commandDomain() const;
   virtual void setCommandDomain( int domain);

   //@(
   virtual int commandProtocol() const;
   virtual void setCommandProtocol( int protocol);

   //@(
   virtual int command() const;
   virtual void setCommand( int commandId);

   //@(
   virtual const char* parametersBuffer() const;
   virtual void setParametersBuffer(const DtString& paramsBuffer);

   virtual void printDataToStream(std::ostream& stream) const;

   virtual const char* commandString() const;

   virtual const char* domainString() const;

   virtual const char* protocolString() const;

public:

   static void setDomainToString(DtDomainToStringFunc func);
   static void setProtocolToString(DtProtocolToStringFunc func);
   static void setCommandToString(DtCommandToStringFunc func);

protected:

   virtual DtLgrCommandData* params() const;

   void initData();

protected:

   static DtDomainToStringFunc theDomainToStringFunc;
   static DtProtocolToStringFunc theProtocolToStringFunc;
   static DtCommandToStringFunc theCommandToStringFunc;
};