vrforces5.2/classref/embedded_task_forward_task_8h_source.html

 /*******************************************************************************

 ** Copyright (c) 2014 MAK Technologies, Inc.

 ** All rights reserved.

 *******************************************************************************/


 #pragma once


 #include "vrftasks/simTask.h"

 #include "vrftasks/vrftasksDefines.h"

 #include <vrfutil/rwUUID.h>


 #include <readerWriter/rwString.h>


 class DtRwString;


 class DT_DLL_vrftasks DtEmbeddedTaskForwardTask : public DtSimTask{


 public:

    DtEmbeddedTaskForwardTask();

    DtEmbeddedTaskForwardTask(const DtString& mtlName, DtReaderWriterRegistry* parentRegistry = NULL);

    DtEmbeddedTaskForwardTask(

       const DtString& mtlName, const DtEmbeddedTaskForwardTask& orig, DtReaderWriterRegistry* parentRegistry = NULL);


    virtual ~DtEmbeddedTaskForwardTask() override;


    DtEmbeddedTaskForwardTask& operator=(const DtEmbeddedTaskForwardTask& orig);

    virtual DtSimTask* clone(const DtString& mtlName, DtReaderWriterRegistry* parentRegistry = NULL) const override;


    virtual const DtSimTaskMessageType& type() const override;

    static DtSimTask* creator();


    virtual int netRepSize() const override;

    virtual bool setFromNet(const char* buff, unsigned contentSize) override;

    virtual bool setToNet() override;


    virtual DtString stringRep() const override;


    virtual const DtString& embeddedEntityName() const;

    virtual void setEmbeddedEntityName(const DtString& name);


    virtual bool blockToCompletion() const;

    virtual void setBlockToCompletion(bool blocking);


    virtual const DtSimTask* taskToForward() const;

    virtual void setTaskToForward(const DtSimTask* tsk);


 protected:

    virtual void putData(std::string& fp, int indentLevel = 0) override;

    virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,

       const DtVariableBindingsList& variableBindings) override;


 protected:

    DtRwString myEmbeddedEntityName;

    DtRwBoolean myBlockToCompletion;


    DtSimTask* myTaskToForward;

 };

DtRwString
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20

DtVrfObjectMessageTypeTemplate< DtTaskMessageType >

DtReaderWriterRegistry
Definition: readerWriterRegistry.h:39

rwUUID.h
Contains the DtUUID class declaration.

DtSimTask::clone
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...

DtVariableBindingsList
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29

DtSimTask::setFromNet
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().

DtReaderWriter::SearchPaths
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92

DtSimTask::setToNet
virtual bool setToNet()
Calls netRep() to create the network buffer. Casts the resulting myNetRep to type DtNetSimTask*...

DT_DLL_vrftasks
#define DT_DLL_vrftasks
This file is used to determine how to build.
Definition: vrftasksDefines.h:26

DtSimTask::putData
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...

rwString.h

DtEmbeddedTaskForwardTask
The DtEmbeddedSetForwardTask is a task container for DtSimTask instances which are addressed to an Em...
Definition: embeddedTaskForwardTask.h:23

DtRwBoolean
Description: Readable, Writable bool.
Definition: rwBoolean.h:26

DtSimTask
DtSimTask is an abstract base class from which real tasks can derive. It manages the read/write capab...
Definition: simTask.h:30

DtSimTask::stringRep
virtual DtString stringRep() const =0
Returns a human-readable string representation of the task. This string representation is used to dis...

DtSimTask::operator=
const DtSimTask & operator=(const DtSimTask &orig)
assignment operator; same as copy constructor

DtSimTask::getData
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...

DtString

DtEmbeddedTaskForwardTask::myBlockToCompletion
DtRwBoolean myBlockToCompletion
Indicates whether the DtEmbeddedEntityController should treat the forwarded task as a subtask and wai...
Definition: embeddedTaskForwardTask.h:76

DtSimTask::type
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.

vrftasksDefines.h

DtEmbeddedTaskForwardTask::myTaskToForward
DtSimTask * myTaskToForward
Definition: embeddedTaskForwardTask.h:78

simTask.h

DtSimTask::netRepSize
virtual int netRepSize() const
Returns the size in bytes of the network representation of the class. This is the size in bytes of th...

DtEmbeddedTaskForwardTask::myEmbeddedEntityName
DtRwString myEmbeddedEntityName
Definition: embeddedTaskForwardTask.h:74