Value.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="Value.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------

#include <system/string.h>
#include <system/nullable.h>
#include <system/date_time.h>
#include <cstdint>

#include "aspose.tasks.cpp/Duration.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"

namespace Aspose
{
namespace Tasks
{
class ExtendedAttributeDefinition;
namespace IO
{
namespace MSProject
{
class MPP12OutlineCodeDefinitionWriter;
class MPP14OutlineCodeDefinitionWriter;
class MPPOutlineCodeDefinitionWriter;
class MPPReader;
} // namespace MSProject
namespace Pwa
{
namespace InternalApi
{
class InternalApiProjectSerializer;
namespace Mapping
{
class ExtendedAttributeDefinitionMapper;
class ExtendedAttributeDefinitionToRawValuesMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
namespace Xml
{
class OutlineValueXml;
} // namespace Xml
} // namespace IO
class OutlineCodesSynchronizer;
class OutlineValue;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerable;
template <typename> class List;
} // namespace Generic
} // namespace Collections
class Decimal;
class Guid;
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents a value in a value list.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS Value : public System::Object
{
    typedef Value ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeDefinitionToRawValuesMapper;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::InternalApiProjectSerializer;
    friend class Aspose::Tasks::ExtendedAttributeDefinition;
    friend class Aspose::Tasks::IO::MSProject::MPPReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14OutlineCodeDefinitionWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP12OutlineCodeDefinitionWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPOutlineCodeDefinitionWriter;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ExtendedAttributeDefinitionMapper;
    friend class Aspose::Tasks::IO::Xml::OutlineValueXml;
    friend class Aspose::Tasks::OutlineCodesSynchronizer;
    
public:

    /// <summary>
    /// Gets the unique identifier of a value across a project.
    /// <para>It's important to not have same identifiers for different <see cref="Value"></see> instances.</para>
    /// <para>Minimal <see cref="Id"></see> value is <c>1</c>.</para>
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Id();
    /// <summary>
    /// Sets the unique identifier of a value across a project.
    /// <para>It's important to not have same identifiers for different <see cref="Value"></see> instances.</para>
    /// <para>Minimal <see cref="Id"></see> value is <c>1</c>.</para>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Id(int32_t value);
    /// <summary>
    /// Gets a GUID which identifies this value among others in the entire project.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Guid get_ValueGuid();
    /// <summary>
    /// Gets the actual value in internal representation. Prefer using strongly typed properties which are listed below.
    /// </summary>
    /// <remarks>
    /// <para>If you want to set Text value prefer using strongly typed <see cref="StringValue"></see> property.</para>
    /// <para>If you want to set Number or Cost value prefer using strongly typed <see cref="NumericValue"></see> property.</para>
    /// <para>If you want to set Date/Start/Finish values, prefer using strongly typed <see cref="DateTimeValue"></see> property.</para>
    /// <para>If you want to set Duration value prefer using strongly typed <see cref="Duration"></see> property.</para>
    /// <para>If your type wasn't listed, use <see cref="Val"></see> property.</para>
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::String get_Val();
    /// <summary>
    /// Sets the actual value in internal representation. Prefer using strongly typed properties which are listed below.
    /// </summary>
    /// <remarks>
    /// <para>If you want to set Text value prefer using strongly typed <see cref="StringValue"></see> property.</para>
    /// <para>If you want to set Number or Cost value prefer using strongly typed <see cref="NumericValue"></see> property.</para>
    /// <para>If you want to set Date/Start/Finish values, prefer using strongly typed <see cref="DateTimeValue"></see> property.</para>
    /// <para>If you want to set Duration value prefer using strongly typed <see cref="Duration"></see> property.</para>
    /// <para>If your type wasn't listed, use <see cref="Val"></see> property.</para>
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_Val(const System::String& value);
    /// <summary>
    /// Gets the actual value which is used to represent Text string.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Text value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::String get_StringValue();
    /// <summary>
    /// Sets the actual value which is used to represent Text string.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Text value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_StringValue(const System::String& value);
    /// <summary>
    /// Gets the actual value which is used to represent number or cost value.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Number or Cost value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::Decimal get_NumericValue();
    /// <summary>
    /// Sets the actual value which is used to represent number or cost value.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Number or Cost value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_NumericValue(System::Decimal value);
    /// <summary>
    /// Gets the actual value which is used to represent Duration.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Duration value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::Nullable<Aspose::Tasks::Duration> get_Duration();
    /// <summary>
    /// Sets the actual value which is used to represent Duration.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the Duration value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_Duration(System::Nullable<Aspose::Tasks::Duration> value);
    /// <summary>
    /// Gets the actual value if it can be represented as DateTime. Default value is <see cref="DateTime::MinValue"></see>.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the DateTime value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::DateTime get_DateTimeValue() const;
    /// <summary>
    /// Sets the actual value if it can be represented as DateTime. Default value is <see cref="DateTime::MinValue"></see>.
    /// </summary>
    /// <remarks>
    /// Prefer this property over the <see cref="Val"></see>, when you need to set the DateTime value.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_DateTimeValue(System::DateTime value);
    /// <summary>
    /// Gets the description of a value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Description();
    /// <summary>
    /// Sets the description of a value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Description(const System::String& value);
    /// <summary>
    /// Gets the phonetic information about custom field name.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Phonetic() const;
    /// <summary>
    /// Sets the phonetic information about custom field name.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Phonetic(const System::String& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="Value"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Value();
    
protected:

    ASPOSE_TASKS_SHARED_API System::Nullable<double> get_SortOrder();
    ASPOSE_TASKS_SHARED_API void set_SortOrder(System::Nullable<double> value);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::OutlineValue> get_OutlineValue() const;
    
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Value>>> ConvertFromOutlineValues(const System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Tasks::OutlineValue>>>& values);
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    static System::DateTime& MinimallySupportedDate();
    static System::DateTime& MaximallySupportedDate();
    
    System::SharedPtr<Aspose::Tasks::OutlineValue> outlineValue;
    System::DateTime dateTimeValue;
    System::String pr_Phonetic;
    
    System::String get_DebuggerDisplay();
    
    Value(const System::SharedPtr<Aspose::Tasks::OutlineValue>& outlineValue);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(Value, CODEPORTING_ARGS(const System::SharedPtr<Aspose::Tasks::OutlineValue>& outlineValue));
    
};

} // namespace Tasks
} // namespace Aspose