VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rwSyncMatrixPlan.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfplan/vrfplanDefines.h"
13 #include <vrfutil/rwUUID.h>
14 #include <readerWriter/rwString.h>
16 #include <vrfplan/plan.h>
17 
22 
24 {
25 public:
26 
28  DtRwSyncMatrixPlan(const DtString& name, DtReaderWriterRegistry* parentRegistry = 0);
29 
31  DtRwSyncMatrixPlan(const DtUUID& object, const DtString& phaseName, const DtPlan* plan = NULL,
32  DtReaderWriterRegistry* parentRegistry = 0);
33 
35  virtual ~DtRwSyncMatrixPlan();
36 
39  DtReaderWriterRegistry * parentRegistry = 0, bool copyPlan = true);
40 
43 
45  virtual DtRwSyncMatrixPlan* clone(const DtString& name,
46  DtReaderWriterRegistry * parentRegistry = 0) const;
47 
48  virtual DtRwSyncMatrixPlan* cloneWithoutPlan(const DtString& name = "",
49  DtReaderWriterRegistry * parentRegistry = 0) const;
50 
52  virtual void setObject(const DtUUID& object);
53  virtual const DtUUID& object() const;
54 
56  virtual void setPhaseName(const DtString& phaseName);
57  virtual const DtString& phaseName() const;
58 
60  virtual void setSummary(const DtString& summary);
61  virtual const DtString& summary() const;
62 
65  virtual DtString planDisplayString() const;
66 
68  virtual void setActivated(bool activated);
69  virtual bool activated() const;
70 
72  virtual void setValid(bool valid);
73  virtual bool valid() const;
74 
76  virtual void setStarted(bool started);
77  virtual bool started() const;
78 
80  virtual void setCompleted(bool completed);
81  virtual bool completed() const;
82 
84  virtual void setLinkWithPreviousPhase(bool linked);
85  virtual bool linkWithPreviousPhase() const;
86 
88  virtual void setPlan(const DtPlan* plan);
89  virtual const DtPlan* plan() const;
90 
91  virtual void putData(std::string& fp, int indentLevel = 0);
92 
93  virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
94  const DtVariableBindingsList& variableBindings);
95 
96  virtual DtString firstSimStatementString() const;
97 
99  virtual void setDisplayStatement(DtSimStatement*);
101  {
102  return myDisplayStatement;
103  }
104 
105 protected:
106 
109 
112 
116 
119 
122 
125 
128 
131 
134 
137 
138 private:
140 };
141 
142 #ifdef _MSC_VER
143 namespace DtBufferSerialize
144 {
145 #endif
146  DT_DLL_vrfplan int getSize(const DtRwSyncMatrixPlan& plan);
149  DT_DLL_vrfplan char* encode(const DtRwSyncMatrixPlan& plan, char *buffer);
150  DT_DLL_vrfplan const char* decode(DtRwSyncMatrixPlan& plan, const char *buffer);
151 #ifdef _MSC_VER
152 }
153 #endif
UUID is a unique ID wrapper class.
Definition: uuid.h:59
class DtRwSyncMatrixPlan:
Definition: rwSyncMatrixPlan.h:23
DT_DLL_readerWriter int getSize(const DtString &val)
The number of bytes required to encode the value.
DtRwBoolean myActivated
Activated status.
Definition: rwSyncMatrixPlan.h:118
DtSimStatement * myDisplayStatement
If there is no summary, the plan statement to use for a display.
Definition: rwSyncMatrixPlan.h:136
DtRwString myPhaseName
The phase name.
Definition: rwSyncMatrixPlan.h:111
virtual DtlObjPtr getData(DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Deriving class overrides these to get/put class specific data.
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
DtRwBoolean myLinkWithPreviousPhase
Link status.
Definition: rwSyncMatrixPlan.h:130
Definition: readerWriterRegistry.h:39
Contains the DtUUID class declaration.
uuid class
Definition: rwUUID.h:26
DtRwString mySummary
The summary of the plan entry. If the DtPlan&#39;s summary is empty, the summary will be the string repre...
Definition: rwSyncMatrixPlan.h:115
DtRwBoolean myStarted
Started status.
Definition: rwSyncMatrixPlan.h:124
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
std::vector< DtFilename > SearchPaths
Definition: readerWriter.h:92
DtRwBoolean myValid
Valid status.
Definition: rwSyncMatrixPlan.h:121
DT_DLL_readerWriter char * encode(const DtFilename &val, char *buffer)
Serializes the provided value val into buffer. buffer must have at least the number of bytes returned...
class DtPlan:
Definition: plan.h:92
DtPlan * myPlan
The DtPlan instance.
Definition: rwSyncMatrixPlan.h:133
virtual void putData(std::string &fp, int indentLevel=0)
Deriving class overrides these to get/put class specific data.
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
class DtSimStatement:
Definition: simStatement.h:38
const DtSimStatement * displayStatement() const
Definition: rwSyncMatrixPlan.h:100
#define DT_DLL_vrfplan
This file is used to determine how to build.
Definition: vrfplanDefines.h:28
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
DtRwBoolean myCompleted
Completed status.
Definition: rwSyncMatrixPlan.h:127
DT_DLL_readerWriter const char * decode(DtString &val, const char *buffer)
Decodes a value from buffer and places the result in val of the type specified by val...
DtRwUUID myObject
The object.
Definition: rwSyncMatrixPlan.h:108

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)