Aspose.Tasks for C++
PrimaveraReadOptions.h
1 #pragma once
2 //-----------------------------------------------------------------------
3 // <copyright file="PrimaveraReadOptions.cs" company="Aspose Pty Ltd">
4 // Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
5 // </copyright>
6 //-----------------------------------------------------------------------
7 
8 #include <system/object.h>
9 #include <cstdint>
10 
11 #include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
12 
13 namespace Aspose
14 {
15 namespace Tasks
16 {
17 namespace IO
18 {
19 namespace Xer
20 {
21 class XerPrimaveraReader;
22 } // namespace Xer
23 } // namespace IO
24 enum class UndefinedConstraintHandlingBehavior;
25 } // namespace Tasks
26 } // namespace Aspose
27 
28 namespace Aspose {
29 
30 namespace Tasks {
31 
32 /// <summary>
33 /// Allows to specify additional options when reading Primavera Xml or Primavera Xer files.
34 /// </summary>
35 class ASPOSE_TASKS_SHARED_CLASS PrimaveraReadOptions : public System::Object
36 {
38  typedef System::Object BaseType;
39 
40  typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
41  ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
42 
43  friend class Aspose::Tasks::IO::Xer::XerPrimaveraReader;
44 
45 public:
46 
47  /// <summary>
48  /// Gets the UID of a project to read from file containing multiple projects.
49  /// </summary>
50  ASPOSE_TASKS_SHARED_API int32_t get_ProjectUid() const;
51  /// <summary>
52  /// Sets the UID of a project to read from file containing multiple projects.
53  /// </summary>
54  ASPOSE_TASKS_SHARED_API void set_ProjectUid(int32_t value);
55  /// <summary>
56  /// Specifies the behavior used to process tasks with undefined constraints read from XER format.
57  /// </summary>
58  ASPOSE_TASKS_SHARED_API Aspose::Tasks::UndefinedConstraintHandlingBehavior get_UndefinedConstraintHandlingBehavior() const;
59  /// <summary>
60  /// Specifies the behavior used to process tasks with undefined constraints read from XER format.
61  /// </summary>
62  ASPOSE_TASKS_SHARED_API void set_UndefinedConstraintHandlingBehavior(Aspose::Tasks::UndefinedConstraintHandlingBehavior value);
63  /// <summary>
64  /// Gets a flag that specifies whether original unique identifiers of entities should be preserved.
65  /// </summary>
66  ASPOSE_TASKS_SHARED_API bool get_PreserveUids() const;
67  /// <summary>
68  /// Sets a flag that specifies whether original unique identifiers of entities should be preserved.
69  /// </summary>
70  ASPOSE_TASKS_SHARED_API void set_PreserveUids(bool value);
71  /// <summary>
72  /// Gets a flag that specifies whether baseline projects should be loaded. The default value is true.
73  /// </summary>
74  /// <remarks>The flag is applicable to Primavera XML files containing baseline projects (baselines are not supported by XER format).
75  /// The option can be set to false to speed up loading of a large project with baselines when baseline data is not needed.</remarks>
76  ASPOSE_TASKS_SHARED_API bool get_ReadBaselineProjects() const;
77  /// <summary>
78  /// Sets a flag that specifies whether baseline projects should be loaded. The default value is true.
79  /// </summary>
80  /// <remarks>The flag is applicable to Primavera XML files containing baseline projects (baselines are not supported by XER format).
81  /// The option can be set to false to speed up loading of a large project with baselines when baseline data is not needed.</remarks>
82  ASPOSE_TASKS_SHARED_API void set_ReadBaselineProjects(bool value);
83 
84  /// <summary>
85  /// Initializes a new instance of the <see cref="PrimaveraReadOptions"></see> class.
86  /// </summary>
87  ASPOSE_TASKS_SHARED_API PrimaveraReadOptions();
88 
89 protected:
90 
91  ASPOSE_TASKS_SHARED_API System::SharedPtr<PrimaveraReadOptions> Clone();
92  #ifdef ASPOSE_GET_SHARED_MEMBERS
93  ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
94  #endif
95 
96 
97 private:
98 
99  int32_t pr_ProjectUid;
100  Aspose::Tasks::UndefinedConstraintHandlingBehavior pr_UndefinedConstraintHandlingBehavior;
101  bool pr_PreserveUids;
102  bool pr_ReadBaselineProjects;
103 
104 };
105 
106 } // namespace Tasks
107 } // namespace Aspose
108 
109 
Allows to specify additional options when reading Primavera Xml or Primavera Xer files.
Definition: PrimaveraReadOptions.h:36
void set_PreserveUids(bool value)
Sets a flag that specifies whether original unique identifiers of entities should be preserved.
PrimaveraReadOptions()
Initializes a new instance of the PrimaveraReadOptions class.
bool get_ReadBaselineProjects() const
Gets a flag that specifies whether baseline projects should be loaded. The default value is true.
int32_t get_ProjectUid() const
Gets the UID of a project to read from file containing multiple projects.
void set_ReadBaselineProjects(bool value)
Sets a flag that specifies whether baseline projects should be loaded. The default value is true.
void set_ProjectUid(int32_t value)
Sets the UID of a project to read from file containing multiple projects.
Aspose::Tasks::UndefinedConstraintHandlingBehavior get_UndefinedConstraintHandlingBehavior() const
Specifies the behavior used to process tasks with undefined constraints read from XER format.
bool get_PreserveUids() const
Gets a flag that specifies whether original unique identifiers of entities should be preserved.
void set_UndefinedConstraintHandlingBehavior(Aspose::Tasks::UndefinedConstraintHandlingBehavior value)
Specifies the behavior used to process tasks with undefined constraints read from XER format.
Definition: Asn.h:13