Rsc.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="Rsc.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
enum class BookingType;
class Calendar;
enum class CostAccrualType;
class Duration;
template <typename, typename> class Key;
class NullableBool;
enum class RateFormatType;
enum class ResourceType;
enum class RscKey : uint8_t;
enum class WorkGroupType;
} // namespace Tasks
} // namespace Aspose
namespace System
{
class DateTime;
class Decimal;
template <typename> class SmartPtr;
template <typename T0> using SharedPtr = System::SmartPtr<T0>;
class String;
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents supported properties of <see cref="Resource"></see> object.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS Rsc
{
    typedef Rsc ThisType;
    
public:
 
    /// <summary>
    /// Determines how and when resource standard and overtime costs are to be charged, or accrued, to the cost of a task. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<CostAccrualType, RscKey>& AccrueAt();
    /// <summary>
    /// The Active Directory Guid for a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& ActiveDirectoryGuid();
    /// <summary>
    /// Costs incurred for work already performed by resources on their tasks, along with any other recorded costs associated with the task.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& ActualCost();
    /// <summary>
    /// Costs incurred for overtime work already performed on tasks by assigned resources.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& ActualOvertimeCost();
    /// <summary>
    /// The actual amount of overtime work already performed by resource assigned to tasks.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& ActualOvertimeWork();
    /// <summary>
    /// The amount of work through which actual overtime work is protected.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& ActualOvertimeWorkProtected();
    /// <summary>
    /// The amount of work that has already been done by resource assigned to tasks.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& ActualWork();
    /// <summary>
    /// The amount of work through which actual work is protected.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& ActualWorkProtected();
    /// <summary>
    /// The actual cost of a work performed by a resource for the project to-date.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& ACWP();
    /// <summary>
    /// The name of an assignment owner.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& AssignmentOwner();
    /// <summary>
    /// The GUID of an assignment owner.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& AssignmentOwnerGuid();
    /// <summary>
    /// The starting date that a resource is available for work at the units specified for the current time period. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::DateTime, RscKey>& AvailableFrom();
    /// <summary>
    /// The end date that a resource is available for work at the units specified for the current time period. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::DateTime, RscKey>& AvailableTo();
    /// <summary>
    /// The budgeted cost of a work performed by a resource for the project to-date.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& BCWP();
    /// <summary>
    /// The budget cost of a work scheduled for a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& BCWS();
    /// <summary>
    /// The booking type of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Aspose::Tasks::BookingType, RscKey>& BookingType();
    /// <summary>
    /// Budget costs for budget cost resources. Budget resources are assigned only to the project summary task.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& BudgetCost();
    /// <summary>
    /// budget work for budget work and material resources. Budget resources are assigned only to the project summary task. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& BudgetWork();
    /// <summary>
    /// The calendar of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::SharedPtr<Aspose::Tasks::Calendar>, RscKey>& Calendar();
    /// <summary>
    /// Determines whether resource leveling can be done on a resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& CanLevel();
    /// <summary>
    /// The code or other information about a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Code();
    /// <summary>
    /// The total scheduled or projected cost for a resource, based on costs already incurred for work performed by resources assigned to the tasks, in addition to the costs planned for the remaining work. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& Cost();
    /// <summary>
    /// Indicates which cost center the costs accrued by the resource should be charged to.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& CostCenter();
    /// <summary>
    /// The cost that accrues every time that a resource is used.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& CostPerUse();
    /// <summary>
    /// The difference between the baseline cost and total cost for a resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& CostVariance();
    /// <summary>
    /// The date and time when a resource was added to the project. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::DateTime, RscKey>& Created();
    /// <summary>
    /// The earned value cost variance, through the project status date.
    /// CV is the difference between the task's BCWP (budgeted cost of work performed) and ACWP (actual cost of work performed).
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& CV();
    /// <summary>
    /// The email address of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& EMailAddress();
    /// <summary>
    /// The date when a resource is scheduled to complete work on all assigned tasks. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::DateTime, RscKey>& Finish();
    /// <summary>
    /// The group to which a resource belongs.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Group();
    /// <summary>
    ///  Contains the generated unique identification code for the resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Guid();
    /// <summary>
    /// The title or explanatory text of a hyperlink associated with a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Hyperlink();
    /// <summary>
    /// The address for a hyperlink associated with a resource.
    /// </summary>
    /// <remarks>The full address (Hyperlink Href in Microsoft Project) of the hyperlink is a concatenation of HyperlinkAddress and HyperlinkSubAddress.</remarks>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& HyperlinkAddress();
    /// <summary>
    /// The specific location in a document in a hyperlink associated with a task.
    /// </summary>
    /// <remarks>The full address (Hyperlink Href in Microsoft Project) of the hyperlink is a concatenation of HyperlinkAddress and HyperlinkSubAddress.</remarks>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& HyperlinkSubAddress();
    /// <summary>
    /// The position identifier of a resource within the list of resources.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<int32_t, RscKey>& Id();
    /// <summary>
    /// Determines whether a resource was made inactive by a user who has administrative rights. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& Inactive();
    /// <summary>
    /// The initials of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Initials();
    /// <summary>
    /// Determines whether a work, material, or cost resource is a budget resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& IsBudget();
    /// <summary>
    /// Determines whether a resource is a cost resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& IsCostResource();
    /// <summary>
    ///  Shows whether a resource is from the enterprise resource pool (true) or the local resource pool (false). 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& IsEnterprise();
    /// <summary>
    /// Determines whether a resource is generic or not. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& IsGeneric();
    /// <summary>
    /// Determines whether a resource is null.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& IsNull();
    /// <summary>
    /// Shows whether the current resource is a team resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<bool, RscKey>& IsTeamAssignmentPool();
    /// <summary>
    /// The unit of measure for the material resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& MaterialLabel();
    /// <summary>
    /// The maximum number of units representing the maximum capacity for which a resource is available to accomplish any tasks during the current time period.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& MaxUnits();
    /// <summary>
    /// The name of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Name();
    /// <summary>
    /// The text notes in RTF format.
    /// <remarks>Supported for MPP formats only.</remarks>
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& NotesRTF();
    /// <summary>
    /// Notes' plain text extracted from RTF data.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& NotesText();
    /// <summary>
    /// Indicates whether a resource is assigned to more work on a specific task or all tasks than can be completed within normal working capacity.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<NullableBool, RscKey>& Overallocated();
    /// <summary>
    /// The total overtime cost for a resource on all assigned tasks.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& OvertimeCost();
    /// <summary>
    /// The rate of pay for overtime work performed by a resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& OvertimeRate();
    /// <summary>
    /// The units used by Microsoft Project to display the overtime rate.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<RateFormatType, RscKey>& OvertimeRateFormat();
    /// <summary>
    /// The amount of overtime scheduled to be performed by a resource on a task and charged at the overtime rates of the resources involved. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& OvertimeWork();
    /// <summary>
    /// The maximum assignment unit for a resource at any one point in time for all tasks to which the resource is assigned.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& PeakUnits();
    /// <summary>
    /// The percentage of work completed across all tasks.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<int32_t, RscKey>& PercentWorkComplete();
    /// <summary>
    /// The phonetic spelling of the resource name. For use with Japanese only.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& Phonetics();
    /// <summary>
    /// The total amount of non overtime work scheduled to be performed by resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& RegularWork();
    /// <summary>
    /// The remaining scheduled expense that will be incurred in completing the remaining scheduled work.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& RemainingCost();
    /// <summary>
    /// The remaining scheduled overtime expense for a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& RemainingOvertimeCost();
    /// <summary>
    /// The amount of remaining scheduled overtime.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& RemainingOvertimeWork();
    /// <summary>
    /// The time still required to complete a task or set of tasks.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& RemainingWork();
    /// <summary>
    /// The rate of pay for regular, non-overtime work performed by a resource. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::Decimal, RscKey>& StandardRate();
    /// <summary>
    /// The units used by Microsoft Project to display the standard rate.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<RateFormatType, RscKey>& StandardRateFormat();
    /// <summary>
    /// The date when an assigned resource is scheduled to begin working on a task. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::DateTime, RscKey>& Start();
    /// <summary>
    /// The earned value schedule variance, through the project status date.
    /// SV is the difference between budgeted cost of work performed (BCWP) and budgeted cost of work scheduled (BCWS).
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& SV();
    /// <summary>
    /// The type of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<ResourceType, RscKey>& Type();
    /// <summary>
    /// The unique identifier of a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<int32_t, RscKey>& Uid();
    /// <summary>
    /// The NT account associated with a resource.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<System::String, RscKey>& WindowsUserAccount();
    /// <summary>
    /// The total amount of time scheduled for a resource on a task. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<Duration, RscKey>& Work();
    /// <summary>
    /// The type of a workgroup to which a resource belongs.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<WorkGroupType, RscKey>& Workgroup();
    /// <summary>
    /// The difference between baseline work of a resource and the currently scheduled work. 
    /// </summary>
    static ASPOSE_TASKS_SHARED_API Key<double, RscKey>& WorkVariance();
    
public:
    Rsc() = delete;
};
 
} // namespace Tasks
} // namespace Aspose