VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
transferSuppliesTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2012 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrftasks/simTask.h"
12 
14 #include <vlutil/vlNetTypes.h>
15 #include "vrfutil/rwUUID.h"
16 
20 
22 {
23 public:
26 
29  DtTransferSuppliesTask(const DtString & writeName,
30  DtReaderWriterRegistry * parentRegistry = 0);
31 
33  DtTransferSuppliesTask(const DtString & writeName, const
35  parentRegistry = 0);
36 
38  const DtTransferSuppliesTask & operator=(const
39  DtTransferSuppliesTask & orig);
40 
42  virtual ~DtTransferSuppliesTask();
43 
45  virtual const DtSimTaskMessageType& type() const;
46 
48  virtual DtSimTask* clone(const DtString& name,
49  DtReaderWriterRegistry* parentRegistry = 0) const;
50 
52  virtual DtString stringRep() const;
53 
56  virtual const DtEntityType& supplyType() const;
57  virtual void setSupplyType(const DtEntityType& type);
59 
62  virtual const double amount() const;
63  virtual void setAmount(const double amount);
65 
68  virtual const bool maxAmount() const;
69  virtual void setMaxAmount(const bool maxAmount);
71 
74  virtual const double rate() const;
75  virtual void setRate(const double rate);
77 
79 
80  virtual const DtUUID & supplier() const;
81  virtual void setSupplier(const DtUUID&);
83 
86  virtual int netRepSize() const;
87 
89  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize);
90 
93  virtual bool setToNet();
94 
96  static DtSimTask* creator();
97 
98 protected:
100  virtual DtString parameterStringRep() const;
101 
102 protected:
106 
111 
115 
120 
124 
128 
130 };
131 
UUID is a unique ID wrapper class.
Definition: uuid.h:59
DtRwEntityType mySupplyType
Parameter Name: supply-type Parameter Description: DIS/RPR entity type enumeration representing the k...
Definition: transferSuppliesTask.h:110
Definition: readerWriterRegistry.h:39
Contains the DtUUID class declaration.
virtual DtSimTask * clone(const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const =0
Make a copy of this task. Returns a newly allocated instance of a DtSimTask. Override this member fun...
uuid class
Definition: rwUUID.h:26
DtRwReal myAmount
Parameter Name: amount Parameter Description: The supply amount to be transferred. .
Definition: transferSuppliesTask.h:114
DtRwReal myRate
Parameter Name: rate Parameter Description: The rate at which the supply should be transferred...
Definition: transferSuppliesTask.h:123
virtual bool setFromNet(const char *contentBuffer, unsigned contentSize)
Sets mySubtask member from the incoming contentBuffer (cast to type DtNetSimTask). Derived classes should call down to this function first, and then extract their own data starting at the location contentBuffer + DtSimTask::netRepSize().
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...
DtRwBoolean myMaxAmount
Parameter Name: max-amount Parameter Description: Flag to indicate that the maximum supply amount sho...
Definition: transferSuppliesTask.h:119
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
File: rwEntType.h.
Definition: rwEntityType.h:23
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
VR-Link includes.
Definition: transferSuppliesTask.h:21
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30
virtual DtString stringRep() const =0
Returns a human-readable string representation of the task. This string representation is used to dis...
const DtSimTask & operator=(const DtSimTask &orig)
assignment operator; same as copy constructor
virtual const DtSimTaskMessageType & type() const =0
What kind of task am I? Returns a string indicating the kind of task (for example, “move-to”, “follow-entity”). Derived classes must implement this member function to return a unique string representing the type of task. The set of standard task types supplied with VR-Forces is in taskTypes.h.
DtRwUUID mySupplier
Parameter Name: supplier Parameter Description: The entity providing the supplies to be transferred...
Definition: transferSuppliesTask.h:127
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class. This is the size in bytes of th...

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)