VR-Forces 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() override;
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 override;
77 
79  virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;
80 
81  virtual DtString stringRep() const override;
82 
83  static DtSimTask * creator();
84 
86  virtual const DtString & userTaskName() const;
87  virtual void setUserTaskName(const DtString & taskName);
88 
90  virtual const DtString & arg1Text() const;
91  virtual void setArg1Text(const DtString & value);
92 
94  virtual const DtString & arg2Text() const;
95  virtual void setArg2Text(const DtString & value);
96 
98  virtual const DtString & arg3Text() const;
99  virtual void setArg3Text(const DtString & value);
100 
102  virtual const DtString & arg4Text() const;
103  virtual void setArg4Text(const DtString & value);
104 
107  virtual int netRepSize() const override;
108 
110  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
111 
114  virtual bool setToNet() override;
115 
116 protected:
117 
123 };
DtNetU8 myArg2TextLength
Definition: userTask.h:22
DtRwString myArg4Text
Definition: userTask.h:122
DtRwString myArg3Text
Definition: userTask.h:121
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:118
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:120
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:119
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 Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)