File: CTask.h

package info (click to toggle)
konclude 0.7.0%2B1137~dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 48,824 kB
  • sloc: cpp: 378,238; xml: 116,067; makefile: 38; sh: 8; ansic: 3
file content (205 lines) | stat: -rw-r--r-- 5,576 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 *		Copyright (C) 2013-2015, 2019 by the Konclude Developer Team.
 *
 *		This file is part of the reasoning system Konclude.
 *		For details and support, see <http://konclude.com/>.
 *
 *		Konclude is free software: you can redistribute it and/or modify
 *		it under the terms of version 3 of the GNU Lesser General Public
 *		License (LGPLv3) as published by the Free Software Foundation.
 *
 *		Konclude is distributed in the hope that it will be useful,
 *		but WITHOUT ANY WARRANTY; without even the implied warranty of
 *		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *		GNU (Lesser) General Public License for more details.
 *
 *		You should have received a copy of the GNU (Lesser) General Public
 *		License along with Konclude. If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef KONCLUDE_SCHEDULER_CTASK_H
#define KONCLUDE_SCHEDULER_CTASK_H

// Libraries includes


// Namespace includes
#include "SchedulerSettings.h"
#include "CTaskStatus.h"
#include "CTaskResult.h"
#include "CBooleanTaskResult.h"
#include "CTaskHandleContext.h"
#include "CTaskContext.h"
#include "CTaskContextBase.h"
#include "CTaskOwner.h"


// Other includes
#include "Utilities/Container/CLinker.h"
#include "Utilities/Container/CSortedLinker.h"
#include "Utilities/Container/CNegLinker.h"
#include "Utilities/Memory/CMemoryPool.h"
#include "Utilities/Memory/CMemoryPoolContainer.h"
#include "Utilities/Memory/CDeletionContainer.h"
#include "Utilities/Memory/CObjectAllocator.h"


#include "Concurrent/Callback/CCallbackData.h"


// Logger includes
#include "Logger/CLogger.h"



namespace Konclude {

	using namespace Utilities;
	using namespace Utilities::Container;
	using namespace Utilities::Memory;
	using namespace Concurrent::Callback;

	namespace Scheduler {


		/*! 
		 *
		 *		\class		CTask
		 *		\author		Andreas Steigmiller
		 *		\version	0.1
		 *		\brief		TODO
		 *
		 */
		class CTask : public CSortedLinkerBase<CTask*,CTask,CTask>, public CMemoryPoolContainer, public CDeletionContainer {
			// public methods
			public:
				//! Constructor
				CTask(CMemoryPool* memoryPool = nullptr);

				//! Destructor
				virtual ~CTask();

				CTask* setTaskID(cint64 id);
				cint64 getTaskID() const;

				CTask* setTaskDepth(cint64 taskDepth);
				cint64 getTaskDepth() const;

				CTask* setTaskType(cint64 taskType);
				cint64 getTaskType() const;

				double getTaskPriority() const;
				CTask* setTaskPriority(double taskPriority);

				CTask* getParentTask() const;
				CTask* getRootTask() const;

				CTask* setParentTask(CTask* parentTask);
				CTask* setRootTask(CTask* rootTask);

				CTaskResult* getTaskResult();
				CTaskStatus* getTaskStatus();

				virtual CTaskContext* getTaskContext(CTaskHandleContext* context);

				virtual CTask* makeTaskReference(CTask* dependedTask, CTaskHandleContext* handlerContext);

				virtual CTask* initTask(CTask* parentTask, CTaskHandleContext* context);

				virtual CTask* completeTask();

				CTask* incActiveReferenceCount(cint64 incCount = 1);
				CTask* decActiveReferenceCount(cint64 decCount = 1);
				cint64 getActiveReferenceCount() const;
				bool hasActiveReferencedTask() const;

				CTask* incDependedStatusUpdatesCount(cint64 incCount = 1);
				CTask* decDependedStatusUpdatesCount(cint64 decCount = 1);
				cint64 getDependedStatusUpdatesCount() const;
				bool hasDependedStatusUpdates() const;

				bool hasDependedStatusUpdatesOrActiveReferencedTasks() const;

				CXNegLinker<CTask*>* getReferencedTaskLinker();
				CTask* setReferencedTaskLinker(CXNegLinker<CTask*>* referencedTaskLinker);
				CTask* appendReferencedTaskLinker(CXNegLinker<CTask*>* referencedTaskLinker);

				CCallbackData* getCallbackLinker();
				CTask* setCallbackLinker(CCallbackData* callback);
				CTask* addCallbackLinker(CCallbackData* callback);


				CTaskOwner* getTaskOwner();
				CTask* setTaskOwner(CTaskOwner* taskOwner);
				CTask* clearTaskOwner();
				bool hasTaskOwner(CTaskOwner* taskOwner);
				bool hasTaskOwner();

				bool hasNoTaskOwnerAndNoParentTask();


				bool clearUninitializedReferenceTasks();


				static inline bool sortedLinkerDataCompare(CTask* const & beforeData1, CTask* const & data2) {
					return beforeData1->getTaskPriority() >= data2->getTaskPriority();
				}

				CTask* setCompletionRequested(bool requested);
				bool getCompletionRequested();
				bool isCompletionRequested();

				bool isTaskRelevant();
				CTask* setTaskRelevant(bool relevant);

				bool isTaskDispenseMarked();
				CTask* setTaskDispenseMarked(bool dispenseable);


			// protected methods
			protected:
				CTask* setCompletionNegatorConnector(CNegator* negator);

				virtual CTaskStatus* createTaskStatus(CTaskHandleContext* handlerContext) = 0;
				virtual CTaskResult* createTaskResult(CTaskHandleContext* handlerContext) = 0;

			// protected variables
			protected:
				cint64 mTaskID;
				cint64 mTaskType;
				double mTaskPriority;
				bool mTaskRelevant;
				bool mTaskDispensMarked;
				CTaskStatus* mTaskStatus;
				CTaskResult* mTaskResult;

				CTaskContext* mTaskContext;
				CTaskOwner* mTaskOwner;

				CTask* mParentTask;
				CTask* mRootTask;
				cint64 mActiveTaskReferenceCount;
				cint64 mDependedStatusUpdatesCount;
				cint64 mTaskDepth;

				CXNegLinker<CTask*>* mReferencedTaskLinker;
				CNegator* mCompletionNegator;
				CCallbackData* mCallbackLinker;

				bool mCompletionRequested;


			// private methods
			private:

			// private variables
			private:

		};

	}; // end namespace Scheduler

}; // end namespace Konclude

#endif // KONCLUDE_SCHEDULER_CTASK_H