VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
embeddedSetForwardTask.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
9 
10 #pragma once
11 
12 #include "vrftasks/simTask.h"
14 #include <vrfutil/rwUUID.h>
15 
16 #include <readerWriter/rwString.h>
17 
18 class DtSetDataRequest;
19 
24 {
25 
26 public:
28  DtEmbeddedSetForwardTask(const DtString& mtlName, DtReaderWriterRegistry* parentRegistry = NULL);
29  DtEmbeddedSetForwardTask(const DtString& mtlName,
30  const DtEmbeddedSetForwardTask& orig, DtReaderWriterRegistry* parentRegistry = NULL);
31 
33 
35  virtual DtSimTask* clone(const DtString& mtlName, DtReaderWriterRegistry* parentRegistry = NULL) const;
36 
37  virtual const DtSimTaskMessageType& type() const;
38  static DtSimTask* creator();
39 
42  virtual int netRepSize() const;
43  virtual bool setFromNet(const char* buff, unsigned contentSize);
44  virtual bool setToNet();
46 
48  virtual DtString stringRep() const;
49 
52  virtual const DtString& embeddedEntityName() const;
53  virtual void setEmbeddedEntityName(const DtString& name);
55 
58  virtual const DtSetDataRequest* setToForward() const;
60  virtual void setSetToForward(const DtSetDataRequest* tsk);
62 
63 protected:
64  virtual void putData(std::string& fp, int indentLevel = 0);
65  virtual DtlObjPtr getData(DtlObjPtr args,
66  const DtReaderWriter::SearchPaths& searchPaths,
67  const DtVariableBindingsList& variableBindings);
68 
69 protected:
72 };
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 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...
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
The DtEmbeddedSetForwardTask is a task container for DtSetDataRequest instances which are addressed t...
Definition: embeddedSetForwardTask.h:23
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().
DtRwString myEmbeddedEntityName
Definition: embeddedSetForwardTask.h:70
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
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.
DtSetDataRequest * mySetToForward
Definition: embeddedSetForwardTask.h:71
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 Wed Mar 27 22:49:11 EDT 2024 from SVN revision 264633
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)