VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
keepStationTask.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 
12 #include "vrftasks/simTask.h"
13 #include <readerWriter/rwString.h>
14 #include "readerWriter/rwVector.h"
15 #include "vrfutil/rwUUID.h"
16 #include <vlpi/netStructs.h>
17 
62 {
63 public:
66 
69  DtKeepStationTask(const DtString & writeName,
70  DtReaderWriterRegistry * parentRegistry = 0);
71 
74  DtKeepStationTask(const DtString & writeName, const DtKeepStationTask &
75  orig,DtReaderWriterRegistry * parentRegistry = 0);
76 
78  const DtKeepStationTask & operator=(const DtKeepStationTask & orig);
79 
80  virtual ~DtKeepStationTask() override;
81 
83  virtual const DtSimTaskMessageType& type() const override;
84 
86  virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;
87 
89  virtual DtString stringRep() const override;
90 
92  virtual const DtUUID & entityToFollow() const;
93  virtual void setEntityToFollow(const DtUUID & entity);
94 
97  virtual double offsetDistance() const;
98  virtual void setOffsetDistance(double offsetDistance);
99 
102  virtual double heading() const;
103  virtual void setHeading(double heading);
104 
106  virtual int mode() const;
107  virtual void setMode(int);
108 
111  virtual int netRepSize() const override;
112 
114  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
115 
118  virtual bool setToNet() override;
119 
120  static DtSimTask * creator();
121 
122 protected:
127 };
128 
UUID is a unique ID wrapper class.
Definition: uuid.h:59
DtRwReal myOffsetDistance
Definition: keepStationTask.h:124
DtRwReal myHeading
Definition: keepStationTask.h:125
DtRwInt myMode
Definition: keepStationTask.h:126
DtRwUUID myEntityToFollow
Definition: keepStationTask.h:123
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
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().
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
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30
const char int mode
Definition: ioapi.h:38
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
DtKeepStationTask represents a the keep station mode of the follow entity task for an entity to perfo...
Definition: keepStationTask.h:61
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 Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)