VR-Forces 5.0.1 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
embarkTask.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 <vlutil/vlNetTypes.h>
13 #include <readerWriter/rwString.h>
14 #include "readerWriter/rwVector.h"
15 #include <readerWriter/rwInt.h>
16 #include <readerWriter/rwBoolean.h>
17 #include <vlpi/netStructs.h>
18 #include "vrfutil/rwUUID.h"
19 
26 {
27 
28 public:
29 
31 
32  DtEmbarkTask();
33 
34 
37 
38  DtEmbarkTask(const DtString & writeName,
39  DtReaderWriterRegistry * parentRegistry = 0);
40 
41 
43 
44  DtEmbarkTask(const DtString & writeName, const
46  parentRegistry = 0);
47 
48 
50 
51  const DtEmbarkTask & operator=(const
52  DtEmbarkTask & orig);
53 
54 
55  virtual ~DtEmbarkTask();
56 
57 
59 
60  virtual const DtSimTaskMessageType& type() const;
61 
62 
64 
65  virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry *
66  parentRegistry = 0) const;
67 
68 
70 
71  virtual DtString stringRep() const;
72 
73 
76  virtual void setParent(const DtUUID&);
77 
78 
81  virtual const DtUUID& parent() const;
82 
83 
86 
87  virtual int netRepSize() const;
88 
89 
91 
92  virtual bool setFromNet(const char* contentBuffer,
93  unsigned contentSize);
94 
95 
98 
99  virtual bool setToNet();
100 
101 
102  static DtSimTask * creator();
103 
104 
105  virtual void setLoadOverride(bool b);
106  virtual bool loadOverride() const;
107 
108  virtual void setLoadOverridePosition(const DtVector&);
109  virtual const DtVector& loadOverridePosition() const;
110 
115  virtual void setEmbarkInSlot(int s);
116  virtual int embarkInSlot() const;
117 
118  virtual void setSlotName(const DtString&);
119  virtual const DtString& slotName() const;
120 
121  virtual void setSlotType(const DtString&);
122  virtual const DtString& slotType() const;
123 
124  virtual void setChooseAnyAvailableSlotIfTaken(bool);
125  virtual bool chooseAnyAvailableSlotIfTaken() const;
126 
127 protected:
135 };
UUID is a unique ID wrapper class.
Definition: rwUUID.h:226
DtEmbarkTask represents a task to a entity to embark onto a parent entity.
Definition: embarkTask.h:25
DtRwBoolean myChooseAnyAvailableIfSlotTaken
Definition: embarkTask.h:132
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
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...
Description: Readable, Writable uuid string. Use this class in order to convert from object marking t...
Definition: rwUUID.h:428
DtRwOffsetVector myLoadOverridePosition
Definition: embarkTask.h:130
DtRwString mySlotType
Definition: embarkTask.h:134
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().
DtRwUUID myParent
Definition: embarkTask.h:128
Description: Readable, Writable int.
Definition: rwInt.h:25
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
Specialized vector that can be used for the knowledge of an &quot;offset&quot; rather than location vector...
Definition: rwVector.h:109
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
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
DtRwInt myEmbarkInSlot
Definition: embarkTask.h:131
DtRwString mySlotName
Definition: embarkTask.h:133
DtRwBoolean myLoadOverride
Definition: embarkTask.h:129
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.
File: rwVector.h.
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)