VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
sendTaskMessageTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2007 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 
11 #pragma once
12 
13 #include "vrftasks/simTask.h"
15 #include <readerWriter/rwString.h>
16 #include "vrfutil/rwUUID.h"
17 
18 class DtSimTask;
19 
24 {
25 public:
28 
30  DtSendTaskMessageTask(const DtString& writeName,
31  DtReaderWriterRegistry* parentRegistry = NULL);
32 
34  DtSendTaskMessageTask(const DtString & writeName, const DtSendTaskMessageTask& orig,
35  DtReaderWriterRegistry* parentRegistry = NULL);
36 
38  virtual ~DtSendTaskMessageTask();
39 
42 
44  virtual const DtSimTaskMessageType& type() const;
45 
47  virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry *
48  parentRegistry = 0) const;
49 
53 
54  virtual const DtUUID& uuid() const;
55  virtual void setUUID(const DtUUID& name);
57 
59  virtual const DtSimTask* task() const;
61  virtual void setTask(const DtSimTask* task);
62 
64  virtual DtString stringRep() const;
65 
67  virtual int netRepSize() const;
68 
70  virtual bool setFromNet(const char* contentBuffer,
71  unsigned contentSize);
72 
74  virtual bool setToNet();
75 
77  static DtSimTask* creator();
78 
79 protected:
81 
82  virtual void putData(std::string& fp, int indentLevel = 0);
83  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
84  const DtVariableBindingsList& variableBindings);
86 
87 protected:
90 };
91 
UUID is a unique ID wrapper class.
Definition: rwUUID.h:229
DtSimTask * myTask
Definition: sendTaskMessageTask.h:89
DtRwUUID myUUID
Definition: sendTaskMessageTask.h:88
Definition: readerWriterRegistry.h:39
Contains the DtUUID class declaration.
virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
getData is just used to get us past the type in the data stream, since it&#39;s not actually stored...
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:431
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
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().
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...
A task to send a task message to another entity though the radio. An entity receiving this task will ...
Definition: sendTaskMessageTask.h:23
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.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
virtual void putData(std::string &fp, int indentLevel=0)
putData writes our type, which is provided by the virtual type accessor of the deriving class...
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.
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 Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)