VR-Forces 4.0.4 Class Documentation: include/vrftasks/userTask.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 1999 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: userTask.h,v $ $Revision: 1.13 $ $State: Exp $
00007 *********************************************************************/
00008 
00011 
00012 #ifndef DtUserTask_H_
00013 #define DtUserTask_H_
00014 
00015 #include "vrftasks/simTask.h"
00016 #include "vrfutil/rwString.h"
00017 #include <vlutil/vlNetTypes.h>
00018 
00022 struct DtNetUserTask
00023 {
00024    DtNetU8    myUserTaskNameLength;
00025    DtNetU8    myArg1TextLength;
00026    DtNetU8    myArg2TextLength;
00027    DtNetU8    myArg3TextLength;
00028    DtNetU8    myArg4TextLength;
00029 };
00030 
00056 #include "vrftasks/vrftasksDefines.h"
00057 class DT_DLL_vrftasks DtUserTask : public DtSimTask
00058 {
00059 public:
00060 
00062    DtUserTask();
00063 
00066    DtUserTask(const DtString & writeName, 
00067       DtReaderWriterRegistry * parentRegistry = 0);
00068 
00070    virtual ~DtUserTask();
00071 
00073    DtUserTask(const DtString & writeName, const DtUserTask & orig, 
00074       DtReaderWriterRegistry * parentRegistry = 0);
00075 
00077    DtUserTask& operator=(const DtUserTask & orig);
00078 
00080    virtual int type() const;
00081 
00083    virtual DtSimTask * clone(const DtString & name, DtReaderWriterRegistry * 
00084       parentRegistry = 0) const;
00085 
00086    virtual DtString stringRep() const;
00087 
00088    static DtSimTask * creator();
00089 
00091    virtual const DtString & userTaskName() const;
00092    virtual void setUserTaskName(const DtString & taskName);
00093 
00095    virtual const DtString & arg1Text() const;
00096    virtual void setArg1Text(const DtString & value);
00097 
00099    virtual const DtString & arg2Text() const;
00100    virtual void setArg2Text(const DtString & value);
00101 
00103    virtual const DtString & arg3Text() const;
00104    virtual void setArg3Text(const DtString & value);
00105 
00107    virtual const DtString & arg4Text() const;
00108    virtual void setArg4Text(const DtString & value);
00109 
00112    virtual int netRepSize() const;
00113 
00115    virtual bool setFromNet(const char* contentBuffer, 
00116       unsigned contentSize);
00117 
00120    virtual bool setToNet();
00121 
00122 protected:
00123 
00124    DtRwString myUserTaskName;
00125    DtRwString myArg1Text;
00126    DtRwString myArg2Text;
00127    DtRwString myArg3Text;
00128    DtRwString myArg4Text;
00129 };
00130 
00131 #endif