VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
sendSetMessageTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2007 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
10 #pragma once
11 
13 #include <readerWriter/rwString.h>
14 #include "vrftasks/simTask.h"
15 #include "vrfutil/rwUUID.h"
16 
17 class DtSetDataRequest;
18 
23 {
24 public:
27 
29  DtSendSetMessageTask(const DtString& writeName,
30  DtReaderWriterRegistry* parentRegistry = NULL);
31 
33  DtSendSetMessageTask(const DtString & writeName, const DtSendSetMessageTask& orig,
34  DtReaderWriterRegistry* parentRegistry = NULL);
35 
37  virtual ~DtSendSetMessageTask() override;
38 
41 
43  virtual const DtSimTaskMessageType& type() const override;
44 
46  virtual DtSimTask * clone(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0) const override;
47 
51 
52  virtual const DtUUID& uuid() const;
53  virtual void setUUID(const DtUUID& name);
55 
57  virtual const DtSetDataRequest* setRequest() const;
59  virtual void setSetRequest(const DtSetDataRequest* task);
60 
62  virtual DtString stringRep() const override;
63 
65  virtual int netRepSize() const override;
66 
68  virtual bool setFromNet(const char* contentBuffer, unsigned contentSize) override;
69 
71  virtual bool setToNet() override;
72 
74  static DtSimTask* creator();
75 
76 protected:
78 
79  virtual void putData(std::string& fp, int indentLevel = 0) override;
80  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
81  const DtVariableBindingsList& variableBindings) override;
83 
84 protected:
87 };
88 
UUID is a unique ID wrapper class.
Definition: uuid.h:59
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
DtSetDataRequest is an abstract base class from which real setDataRequests can derive. It manages the read/write capability; derived classes need only use and register read/writatble data types for derived information.
Definition: setDataRequest.h:41
DtRwUUID myUUID
Definition: sendSetMessageTask.h:85
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*...
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26
virtual void putData(std::string &fp, int indentLevel=0) override
putData writes our type, which is provided by the virtual type accessor of the deriving class...
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30
A task to send a set message to another entity though the radio. An entity receiving this task will s...
Definition: sendSetMessageTask.h:22
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 DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override
getData is just used to get us past the type in the data stream, since it&#39;s not actually stored...
DtSetDataRequest * mySetRequest
Definition: sendSetMessageTask.h:86
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 Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)