setEncumbranceRequest.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2016 VT MAK, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrftasks/setDataRequest.h"
#include <vlpi/netStructs.h>
#include "vrfutil/rwReal.h"
#include "vrftasks/radioMessageTypes.h"

namespace vrfAddSetEncumbranceExample
{
   //class DtSetEncumbranceRequest:
   //
   //Instances of DtSetEncumbrance send a payload mass value to DtManualRotaryWingEncumberedFlightActuator.

   //DtSetEncumbranceString must be a unique string representing the set 
   //(existing string types are defined in msgTypes.h).
   const DtSetMessageType DtSetEncumbranceType = DtString("set-encumbrance");

   //DtSetEncumbranceMenuItemIdName must be a unique string identifying the 
   //DtSetEncumbranceMenuItem object, which inherits from DtVrfTaskSetMenuItem
   const char DtSetEncumbranceMenuItemIdName[] = "DtSetEncumbranceMenuItem";

   class DtSetEncumbranceRequest : public DtSetDataRequest
   {

   public:

         //default constructor
      DtSetEncumbranceRequest();

         //constructor; 
         //If you have a request 'put' itself, the writeName will preface it.
      DtSetEncumbranceRequest(const DtString & writeName, 
         DtReaderWriterRegistry * parentRegistry = 0);

         //copy constructor
      DtSetEncumbranceRequest(const DtString & writeName, const DtSetEncumbranceRequest &
         orig, DtReaderWriterRegistry * parentRegistry = 0);

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

      virtual ~DtSetEncumbranceRequest();

         //Returns DtSetEncumbranceRequestType.
      virtual const DtSetMessageType& type() const;

         //Creates a copy of the request.
      virtual DtSetDataRequest * clone(const DtString & name, 
         DtReaderWriterRegistry * parentRegistry = 0) const;

         //Get a readable string representation of this setDataRequest.
      virtual DtString stringRep() const;

      virtual DtReal encumbrance() const;
      virtual void setEncumbrance(DtReal kgs);

      //Returns the size of the full network representation 
      //padded to an 8-byte boundary.
      virtual int netRepSize() const;

      //Fills in the task from the network buffer.
      virtual bool setFromNet(const char* contentBuffer, 
         unsigned contentSize);

      //Fills in the network buffer (created by base class setDataRequest) with 
      //the set data request contents.
      virtual bool setToNet();

      static DtSetDataRequest * creator();

   protected:

      DtRwReal myEncumbrance;
   };
}