VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
railPathTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2010 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
14 
15 
16 #pragma once
17 
18 #include <vlutil/vlNetTypes.h>
19 
20 #include "vrftasks/simTask.h"
21 #include <readerWriter/rwString.h>
22 #include <readerWriter/rwBoolean.h>
23 #include "readerWriter/rwVector.h"
24 #include <readerWriter/rwInt.h>
25 #include "vrfutil/iteratorBase.h"
26 #include "vrfutil/rwUUID.h"
27 
46 {
47 
48 public:
49 
52 
55  DtRailPathTask(const DtString & writeName,
56  DtReaderWriterRegistry * parentRegistry = 0);
57 
59  DtRailPathTask(const DtString & writeName, const DtRailPathTask & orig,
60  DtReaderWriterRegistry * parentRegistry = 0);
61 
63  const DtRailPathTask & operator=(const DtRailPathTask & orig);
64 
65  virtual ~DtRailPathTask();
66 
68  virtual const DtSimTaskMessageType& type() const;
69 
71  virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry *
72  parentRegistry = 0) const;
73 
75  virtual DtString stringRep() const;
76 
78  virtual void setDestinationSpecified(bool specified);
79 
81  virtual bool destinationSpecified() const;
82 
84  virtual void setDestination(const DtUUID & name);
85 
87  virtual const DtUUID& destination() const;
88 
90  virtual void setDestinationLocation(const DtVector& destination);
91 
93  virtual const DtVector& destinationLocation() const;
94 
95  virtual void setDestinationIsRoute(bool route);
96  virtual bool destinationIsRoute() const;
97 
100  virtual void setTraversalDirection(DtIteratorDirection traversalDirection);
101  virtual DtIteratorDirection traversalDirection() const;
102 
107  virtual void setStartAtClosestPoint(bool startAtClosestPoint);
108  virtual bool startAtClosestPoint() const;
109 
110  virtual int netRepSize() const;
111  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize);
112  virtual bool setToNet();
113 
114  static DtSimTask * creator();
115 
116 protected:
123 };
124 
UUID is a unique ID wrapper class.
Definition: uuid.h:59
DtRwInt myTraversalDirection
Definition: railPathTask.h:121
DtRwUUID myDestination
Definition: railPathTask.h:117
DtRwBoolean myDestinationIsRoute
Definition: railPathTask.h:120
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
DtIteratorDirection
Definition: iteratorBase.h:23
Definition: rwVector.h:23
DtRwVector myDestinationLocation
Definition: railPathTask.h:119
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*...
DtRwBoolean myStartAtClosestPoint
Definition: railPathTask.h:122
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwBoolean myDestinationSpecified
Definition: railPathTask.h:118
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
File: railPathTask.h.
Definition: railPathTask.h:45
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 Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)