VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
userTask.h
Go to the documentation of this file.
1 /*********************************************************************
2 ** Copyright (c) 1999 MaK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrftasks/simTask.h"
12 #include <readerWriter/rwString.h>
13 #include <vlutil/vlNetTypes.h>
14 
19 {
25 };
26 
54 {
55 public:
56 
58  DtUserTask();
59 
62  DtUserTask(const DtString & writeName,
63  DtReaderWriterRegistry * parentRegistry = 0);
64 
66  virtual ~DtUserTask();
67 
69  DtUserTask(const DtString & writeName, const DtUserTask & orig,
70  DtReaderWriterRegistry * parentRegistry = 0);
71 
73  DtUserTask& operator=(const DtUserTask & orig);
74 
76  virtual const DtSimTaskMessageType& type() const;
77 
79  virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry *
80  parentRegistry = 0) const;
81 
82  virtual DtString stringRep() const;
83 
84  static DtSimTask * creator();
85 
87  virtual const DtString & userTaskName() const;
88  virtual void setUserTaskName(const DtString & taskName);
89 
91  virtual const DtString & arg1Text() const;
92  virtual void setArg1Text(const DtString & value);
93 
95  virtual const DtString & arg2Text() const;
96  virtual void setArg2Text(const DtString & value);
97 
99  virtual const DtString & arg3Text() const;
100  virtual void setArg3Text(const DtString & value);
101 
103  virtual const DtString & arg4Text() const;
104  virtual void setArg4Text(const DtString & value);
105 
108  virtual int netRepSize() const;
109 
111  virtual bool setFromNet(const char* contentBuffer,
112  unsigned contentSize);
113 
116  virtual bool setToNet();
117 
118 protected:
119 
125 };
DtNetU8 myArg2TextLength
Definition: userTask.h:22
DtRwString myArg4Text
Definition: userTask.h:124
DtRwString myArg3Text
Definition: userTask.h:123
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
This struct is the FIXED portion of the simulation network representation of a user task...
Definition: userTask.h:18
Definition: readerWriterRegistry.h:39
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...
DtNetU8 myArg4TextLength
Definition: userTask.h:24
DtRwString myUserTaskName
Definition: userTask.h:120
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*...
DtNetU8 myArg1TextLength
Definition: userTask.h:21
class DtUserTask:
Definition: userTask.h:53
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
DtNetU8 myArg3TextLength
Definition: userTask.h:23
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
DtNetU8 myUserTaskNameLength
Definition: userTask.h:20
DtRwString myArg2Text
Definition: userTask.h:122
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.
DtRwString myArg1Text
Definition: userTask.h:121
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 Mon Jun 20 00:38:30 EDT 2022 from SVN revision 244029
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)