Aspose.Tasks for C++
Asn.h
1 #pragma once
2 //-----------------------------------------------------------------------
3 // <copyright file="Asn.cs" company="Aspose Pty Ltd">
4 // Copyright (c) 2002-2023 Aspose Pty Ltd. All Rights Reserved.
5 // </copyright>
6 //-----------------------------------------------------------------------
7 
8 #include <cstdint>
9 
10 #include "aspose_tasks_api_defs.h"
11 
12 namespace Aspose
13 {
14 namespace Tasks
15 {
16 enum class AsnKey;
17 enum class BookingType;
18 class Duration;
19 template <typename, typename> class Key;
20 enum class RateScaleType;
21 enum class RateType;
22 class Resource;
23 class Task;
24 enum class TimeUnitType;
25 enum class WorkContourType;
26 } // namespace Tasks
27 } // namespace Aspose
28 namespace System
29 {
30 class DateTime;
31 class Decimal;
32 template <typename> class SmartPtr;
33 template <typename T0> using SharedPtr = System::SmartPtr<T0>;
34 class String;
35 } // namespace System
36 
37 namespace Aspose {
38 
39 namespace Tasks {
40 
41 /// <summary>
42 /// Represents properties of <see cref="ResourceAssignment"></see> object.
43 /// </summary>
44 class ASPOSE_TASKS_SHARED_CLASS Asn
45 {
46  typedef Asn ThisType;
47 
48 public:
49 
50  /// <summary>
51  /// The unique identifier of an assignment.
52  /// </summary>
53  static ASPOSE_TASKS_SHARED_API Key<int32_t, AsnKey>& Uid();
54  /// <summary>
55  /// The task to which a resource is assigned.
56  /// </summary>
57  static ASPOSE_TASKS_SHARED_API Key<System::SharedPtr<Aspose::Tasks::Task>, AsnKey>& Task();
58  /// <summary>
59  /// The resource assigned to a task.
60  /// </summary>
61  static ASPOSE_TASKS_SHARED_API Key<System::SharedPtr<Aspose::Tasks::Resource>, AsnKey>& Resource();
62  /// <summary>
63  /// The amount of a work completed on an assignment.
64  /// </summary>
65  static ASPOSE_TASKS_SHARED_API Key<int32_t, AsnKey>& PercentWorkComplete();
66  /// <summary>
67  /// The actual cost incurred on an assignment.
68  /// </summary>
69  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& ActualCost();
70  /// <summary>
71  /// The actual finish date of an assignment.
72  /// </summary>
73  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& ActualFinish();
74  /// <summary>
75  /// The actual overtime cost incurred on an assignment.
76  /// </summary>
77  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& ActualOvertimeCost();
78  /// <summary>
79  /// The actual start date of an assignment.
80  /// </summary>
81  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& ActualStart();
82  /// <summary>
83  /// The actual amount of a work incurred on an assignment.
84  /// </summary>
85  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& ActualWork();
86  /// <summary>
87  /// The actual cost of a work performed on an assignment to-date.
88  /// </summary>
89  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& ACWP();
90  /// <summary>
91  /// Determines whether a resource has accepted all of its assignments.
92  /// </summary>
93  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& Confirmed();
94  /// <summary>
95  /// The projected or scheduled cost of an assignment.
96  /// </summary>
97  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& Cost();
98  /// <summary>
99  /// The cost rate table used for this assignment.
100  /// </summary>
101  static ASPOSE_TASKS_SHARED_API Key<RateType, AsnKey>& CostRateTableType();
102  /// <summary>
103  /// The difference between the baseline cost and total cost for an assignment.
104  /// </summary>
105  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& CostVariance();
106  /// <summary>
107  /// The earned value cost variance.
108  /// CV is the difference between the assignment's BCWP (budgeted cost of work performed) and ACWP (actual cost of work performed).
109  /// </summary>
110  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& CV();
111  /// <summary>
112  /// The delay of an assignment.
113  /// </summary>
114  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& Delay();
115  /// <summary>
116  /// The scheduled finish date of an assignment.
117  /// </summary>
118  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& Finish();
119  /// <summary>
120  /// The variance of an assignment finish date from a baseline finish date.
121  /// </summary>
122  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& FinishVariance();
123  /// <summary>
124  /// The title of the hyperlink associated with an assignment.
125  /// </summary>
126  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& Hyperlink();
127  /// <summary>
128  /// The title of the hyperlink associated with an assignment.
129  /// </summary>
130  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& HyperlinkAddress();
131  /// <summary>
132  /// The document bookmark of the hyperlink associated with an assignment.
133  /// </summary>
134  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& HyperlinkSubAddress();
135  /// <summary>
136  /// The difference between baseline work of a task and the currently scheduled work.
137  /// </summary>
138  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& WorkVariance();
139  /// <summary>
140  /// Determines whether the Units have Fixed Rate.
141  /// </summary>
142  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& HasFixedRateUnits();
143  /// <summary>
144  /// Determines whether the consumption of an assigned material resource occurs in a single, fixed amount.
145  /// </summary>
146  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& FixedMaterial();
147  /// <summary>
148  /// The delay caused by leveling.
149  /// </summary>
150  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& LevelingDelay();
151  /// <summary>
152  /// The duration format of a delay.
153  /// </summary>
154  static ASPOSE_TASKS_SHARED_API Key<TimeUnitType, AsnKey>& LevelingDelayFormat();
155  /// <summary>
156  /// Determines whether the Project is linked to another OLE object.
157  /// </summary>
158  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& LinkedFields();
159  /// <summary>
160  /// Determines whether the assignment is a milestone.
161  /// </summary>
162  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& Milestone();
163  /// <summary>
164  /// The text notes associated with an assignment.
165  /// </summary>
166  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& Notes();
167  /// <summary>
168  /// Determines whether the assignment is over-allocated.
169  /// </summary>
170  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& Overallocated();
171  /// <summary>
172  /// The sum of the actual and remaining overtime cost of an assignment.
173  /// </summary>
174  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& OvertimeCost();
175  /// <summary>
176  /// The scheduled overtime work of an assignment.
177  /// </summary>
178  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& OvertimeWork();
179  /// <summary>
180  /// The maximum number of units that a resource is assigned for a task.
181  /// </summary>
182  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& PeakUnits();
183  /// <summary>
184  /// The amount of a non-overtime work scheduled for an assignment.
185  /// </summary>
186  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& RegularWork();
187  /// <summary>
188  /// The remaining projected cost of completing an assignment.
189  /// </summary>
190  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& RemainingCost();
191  /// <summary>
192  /// The remaining projected overtime cost of completing an assignment.
193  /// </summary>
194  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& RemainingOvertimeCost();
195  /// <summary>
196  /// The remaining overtime work scheduled to complete an assignment.
197  /// </summary>
198  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& RemainingOvertimeWork();
199  /// <summary>
200  /// The remaining work scheduled to complete an assignment.
201  /// </summary>
202  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& RemainingWork();
203  /// <summary>
204  /// Determines whether the response has been received for a TeamAssign message.
205  /// </summary>
206  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& ResponsePending();
207  /// <summary>
208  /// The scheduled start date of an assignment.
209  /// </summary>
210  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& Start();
211  /// <summary>
212  /// The date when assignment is stopped.
213  /// </summary>
214  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& Stop();
215  /// <summary>
216  /// The date when assignment is resumed.
217  /// </summary>
218  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& Resume();
219  /// <summary>
220  /// The variance of an assignment start date from a baseline start date.
221  /// </summary>
222  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& StartVariance();
223  /// <summary>
224  /// Determines whether the task is a summary task.
225  /// </summary>
226  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& Summary();
227  /// <summary>
228  /// The earned value schedule variance, through the project status date.
229  /// Schedule variance (SV) is the difference between the BCWP and the BCWS.
230  /// </summary>
231  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& SV();
232  /// <summary>
233  /// The number of units for an assignment.
234  /// </summary>
235  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& Units();
236  /// <summary>
237  /// Determines whether the resource assigned to a task needs to be updated as to the status of the task.
238  /// </summary>
239  static ASPOSE_TASKS_SHARED_API Key<bool, AsnKey>& UpdateNeeded();
240  /// <summary>
241  /// The difference between baseline cost and total cost.
242  /// </summary>
243  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& VAC();
244  /// <summary>
245  /// The amount of scheduled work for an assignment.
246  /// </summary>
247  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& Work();
248  /// <summary>
249  /// The work contour of an assignment.
250  /// </summary>
251  static ASPOSE_TASKS_SHARED_API Key<WorkContourType, AsnKey>& WorkContour();
252  /// <summary>
253  /// The budgeted cost of a work on assignment.
254  /// </summary>
255  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& BCWS();
256  /// <summary>
257  /// The budgeted cost of a work performed on assignment to-date.
258  /// </summary>
259  static ASPOSE_TASKS_SHARED_API Key<double, AsnKey>& BCWP();
260  /// <summary>
261  /// The booking type of an assignment.
262  /// </summary>
263  static ASPOSE_TASKS_SHARED_API Key<Aspose::Tasks::BookingType, AsnKey>& BookingType();
264  /// <summary>
265  /// The duration through which actual overtime work is protected.
266  /// </summary>
267  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& ActualWorkProtected();
268  /// <summary>
269  /// The duration through which actual work is protected.
270  /// </summary>
271  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& ActualOvertimeWorkProtected();
272  /// <summary>
273  /// The actual amount of an overtime work incurred on an assignment.
274  /// </summary>
275  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& ActualOvertimeWork();
276  /// <summary>
277  /// The date that the assignment was created.
278  /// </summary>
279  static ASPOSE_TASKS_SHARED_API Key<System::DateTime, AsnKey>& Created();
280  /// <summary>
281  /// The name of an assignment owner.
282  /// </summary>
283  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& AssignmentOwner();
284  /// <summary>
285  /// The globally unique identifier of an assignment owner.
286  /// </summary>
287  static ASPOSE_TASKS_SHARED_API Key<System::String, AsnKey>& AssignmentOwnerGuid();
288  /// <summary>
289  /// The budgeted cost of resources on an assignment.
290  /// </summary>
291  static ASPOSE_TASKS_SHARED_API Key<System::Decimal, AsnKey>& BudgetCost();
292  /// <summary>
293  /// The budgeted work amount for a work or material resources on an assignment.
294  /// </summary>
295  static ASPOSE_TASKS_SHARED_API Key<Duration, AsnKey>& BudgetWork();
296  /// <summary>
297  /// The time unit for the usage rate of the material resource assignment.
298  /// Returns 0 if not defined.
299  /// </summary>
300  static ASPOSE_TASKS_SHARED_API Key<RateScaleType, AsnKey>& RateScale();
301 
302 public:
303  Asn() = delete;
304 };
305 
306 } // namespace Tasks
307 } // namespace Aspose
308 
309 
Represents properties of ResourceAssignment object.
Definition: Asn.h:45
static Key< System::Decimal, AsnKey > & ActualOvertimeCost()
The actual overtime cost incurred on an assignment.
static Key< System::DateTime, AsnKey > & Stop()
The date when assignment is stopped.
static Key< System::Decimal, AsnKey > & RemainingOvertimeCost()
The remaining projected overtime cost of completing an assignment.
static Key< Duration, AsnKey > & RegularWork()
The amount of a non-overtime work scheduled for an assignment.
static Key< System::DateTime, AsnKey > & Start()
The scheduled start date of an assignment.
static Key< double, AsnKey > & VAC()
The difference between baseline cost and total cost.
static Key< int32_t, AsnKey > & Uid()
The unique identifier of an assignment.
static Key< System::DateTime, AsnKey > & Created()
The date that the assignment was created.
static Key< bool, AsnKey > & UpdateNeeded()
Determines whether the resource assigned to a task needs to be updated as to the status of the task.
static Key< System::String, AsnKey > & Notes()
The text notes associated with an assignment.
static Key< System::Decimal, AsnKey > & ActualCost()
The actual cost incurred on an assignment.
static Key< bool, AsnKey > & Confirmed()
Determines whether a resource has accepted all of its assignments.
static Key< System::SharedPtr< Aspose::Tasks::Resource >, AsnKey > & Resource()
The resource assigned to a task.
static Key< double, AsnKey > & ACWP()
The actual cost of a work performed on an assignment to-date.
static Key< System::Decimal, AsnKey > & Cost()
The projected or scheduled cost of an assignment.
static Key< System::DateTime, AsnKey > & ActualStart()
The actual start date of an assignment.
static Key< Duration, AsnKey > & RemainingOvertimeWork()
The remaining overtime work scheduled to complete an assignment.
static Key< Duration, AsnKey > & Work()
The amount of scheduled work for an assignment.
static Key< System::String, AsnKey > & HyperlinkSubAddress()
The document bookmark of the hyperlink associated with an assignment.
static Key< System::SharedPtr< Aspose::Tasks::Task >, AsnKey > & Task()
The task to which a resource is assigned.
static Key< Duration, AsnKey > & ActualOvertimeWork()
The actual amount of an overtime work incurred on an assignment.
static Key< double, AsnKey > & BCWS()
The budgeted cost of a work on assignment.
static Key< bool, AsnKey > & Overallocated()
Determines whether the assignment is over-allocated.
static Key< System::DateTime, AsnKey > & ActualFinish()
The actual finish date of an assignment.
static Key< Duration, AsnKey > & Delay()
The delay of an assignment.
static Key< Duration, AsnKey > & WorkVariance()
The difference between baseline work of a task and the currently scheduled work.
static Key< TimeUnitType, AsnKey > & LevelingDelayFormat()
The duration format of a delay.
static Key< double, AsnKey > & CostVariance()
The difference between the baseline cost and total cost for an assignment.
static Key< System::String, AsnKey > & AssignmentOwner()
The name of an assignment owner.
static Key< bool, AsnKey > & HasFixedRateUnits()
Determines whether the Units have Fixed Rate.
static Key< Duration, AsnKey > & FinishVariance()
The variance of an assignment finish date from a baseline finish date.
static Key< Duration, AsnKey > & BudgetWork()
The budgeted work amount for a work or material resources on an assignment.
static Key< Duration, AsnKey > & OvertimeWork()
The scheduled overtime work of an assignment.
static Key< double, AsnKey > & SV()
The earned value schedule variance, through the project status date. Schedule variance (SV) is the di...
static Key< double, AsnKey > & PeakUnits()
The maximum number of units that a resource is assigned for a task.
static Key< bool, AsnKey > & ResponsePending()
Determines whether the response has been received for a TeamAssign message.
static Key< Aspose::Tasks::BookingType, AsnKey > & BookingType()
The booking type of an assignment.
static Key< Duration, AsnKey > & StartVariance()
The variance of an assignment start date from a baseline start date.
static Key< WorkContourType, AsnKey > & WorkContour()
The work contour of an assignment.
static Key< System::DateTime, AsnKey > & Finish()
The scheduled finish date of an assignment.
static Key< bool, AsnKey > & LinkedFields()
Determines whether the Project is linked to another OLE object.
static Key< System::String, AsnKey > & Hyperlink()
The title of the hyperlink associated with an assignment.
static Key< RateScaleType, AsnKey > & RateScale()
The time unit for the usage rate of the material resource assignment. Returns 0 if not defined.
static Key< System::String, AsnKey > & HyperlinkAddress()
The title of the hyperlink associated with an assignment.
static Key< bool, AsnKey > & FixedMaterial()
Determines whether the consumption of an assigned material resource occurs in a single,...
static Key< System::Decimal, AsnKey > & RemainingCost()
The remaining projected cost of completing an assignment.
static Key< int32_t, AsnKey > & PercentWorkComplete()
The amount of a work completed on an assignment.
static Key< Duration, AsnKey > & LevelingDelay()
The delay caused by leveling.
static Key< Duration, AsnKey > & ActualWorkProtected()
The duration through which actual overtime work is protected.
static Key< double, AsnKey > & CV()
The earned value cost variance. CV is the difference between the assignment's BCWP (budgeted cost of ...
static Key< double, AsnKey > & Units()
The number of units for an assignment.
static Key< System::DateTime, AsnKey > & Resume()
The date when assignment is resumed.
static Key< Duration, AsnKey > & ActualOvertimeWorkProtected()
The duration through which actual work is protected.
static Key< System::String, AsnKey > & AssignmentOwnerGuid()
The globally unique identifier of an assignment owner.
static Key< RateType, AsnKey > & CostRateTableType()
The cost rate table used for this assignment.
static Key< bool, AsnKey > & Milestone()
Determines whether the assignment is a milestone.
static Key< Duration, AsnKey > & RemainingWork()
The remaining work scheduled to complete an assignment.
static Key< double, AsnKey > & BCWP()
The budgeted cost of a work performed on assignment to-date.
static Key< Duration, AsnKey > & ActualWork()
The actual amount of a work incurred on an assignment.
static Key< bool, AsnKey > & Summary()
Determines whether the task is a summary task.
static Key< System::Decimal, AsnKey > & BudgetCost()
The budgeted cost of resources on an assignment.
static Key< System::Decimal, AsnKey > & OvertimeCost()
The sum of the actual and remaining overtime cost of an assignment.
Represents a property key of a class of the specified type. An instance of this class is used when ge...
Definition: Key.h:78
Definition: Asn.h:29