GraphicalIndicatorCriteria.h

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

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

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

namespace Aspose
{
namespace Tasks
{
enum class FilterComparisonType;
enum class GraphicalIndicatorCriteriaType;
class GraphicalIndicatorCriteriaValue;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Text
{
class StringBuilder;
} // namespace Text
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents one graphical indicator criteria associated with an extended attribute.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS GraphicalIndicatorCriteria final : public System::Object
{
    typedef GraphicalIndicatorCriteria ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
public:

    /// <summary>
    /// Gets the type of comparison made between extended attribute's value and Values that acts as a criteria for the application of the graphical indicator.
    /// <see cref="FilterComparisonType"></see>
    /// </summary>
    ASPOSE_TASKS_SHARED_API FilterComparisonType get_Test() const;
    /// <summary>
    /// Gets the value used to test extended attribute's value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<GraphicalIndicatorCriteriaValue>& get_Value1() const;
    /// <summary>
    /// Gets the second value used to test extended attribute's value in case of 'IsWithin' and 'IsNotWithin' comparison types.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<GraphicalIndicatorCriteriaValue>& get_Value2() const;
    /// <summary>
    /// Gets the index of the image to display when the field meets the criteria.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_ImageIndex() const;
    /// <summary>
    /// Gets the value of <see cref="GraphicalIndicatorCriteriaType"></see> enum which denotes for which rows the indicator is applied.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GraphicalIndicatorCriteriaType get_RowType() const;
    
    /// <summary>
    /// Initializes a new instance of the <see cref="GraphicalIndicatorCriteria"></see> type.
    /// </summary>
    /// <param name="rowType">value of <see cref="GraphicalIndicatorCriteriaType"></see> enum which denotes for which rows the indicator is applied</param>
    /// <param name="test">value of <see cref="FilterComparisonType"></see> denoting the type of comparison performed by the criteria.</param>
    /// <param name="imageIndex">the index of the image to display when the field meets the criteria</param>
    /// <param name="value1">values used in condition check.</param>
    /// <param name="value2">second value (end of interval) used in condition check in case of 'IsWithin' and 'IsNotWithing' conditions.</param>
    /// <exception cref="ArgumentException">Thrown when incorrect combination of arguments is passed to the constructor.</exception>
    ASPOSE_TASKS_SHARED_API GraphicalIndicatorCriteria(GraphicalIndicatorCriteriaType rowType, FilterComparisonType test, int32_t imageIndex, const System::SharedPtr<GraphicalIndicatorCriteriaValue>& value1, const System::SharedPtr<GraphicalIndicatorCriteriaValue>& value2);
    /// <summary>
    /// Initializes a new instance of the <see cref="GraphicalIndicatorCriteria"></see> type.
    /// </summary>
    /// <param name="rowType">value of <see cref="GraphicalIndicatorCriteriaType"></see> enum which denotes for which rows the indicator is applied</param>
    /// <param name="test">value of <see cref="FilterComparisonType"></see> denoting the type of comparison performed by the criteria.</param>
    /// <param name="imageIndex">the index of the image to display when the field meets the criteria</param>
    /// <param name="value">value used in condition check.</param>
    /// <exception cref="ArgumentException">Thrown when incorrect combination of arguments is passed to the constructor.</exception>
    /// <exception cref="ArgumentException">When value of IsWithin of IsNotWithing is passed to test argument. </exception>
    ASPOSE_TASKS_SHARED_API GraphicalIndicatorCriteria(GraphicalIndicatorCriteriaType rowType, FilterComparisonType test, int32_t imageIndex, const System::SharedPtr<GraphicalIndicatorCriteriaValue>& value);
    
    /// <summary>
    /// Returns string representation of the instance of the <see cref="GraphicalIndicatorCriteria"></see> class.
    /// </summary>
    /// <returns>string representation of this object.</returns>
    ASPOSE_TASKS_SHARED_API System::String ToString() const override;
    
protected:

    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    FilterComparisonType pr_Test;
    
    /// <summary>
    /// Gets the type of comparison made between extended attribute's value and Values that acts as a criteria for the application of the graphical indicator.
    /// <see cref="FilterComparisonType"></see>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Test(FilterComparisonType value);
    
    System::SharedPtr<GraphicalIndicatorCriteriaValue> pr_Value1;
    
    /// <summary>
    /// Gets the value used to test extended attribute's value.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Value1(const System::SharedPtr<GraphicalIndicatorCriteriaValue>& value);
    
    System::SharedPtr<GraphicalIndicatorCriteriaValue> pr_Value2;
    
    /// <summary>
    /// Gets the second value used to test extended attribute's value in case of 'IsWithin' and 'IsNotWithin' comparison types.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Value2(const System::SharedPtr<GraphicalIndicatorCriteriaValue>& value);
    
    int32_t pr_ImageIndex;
    
    /// <summary>
    /// Gets the index of the image to display when the field meets the criteria.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ImageIndex(int32_t value);
    
    GraphicalIndicatorCriteriaType pr_RowType;
    
    /// <summary>
    /// Gets the value of <see cref="GraphicalIndicatorCriteriaType"></see> enum which denotes for which rows the indicator is applied.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RowType(GraphicalIndicatorCriteriaType value);
    
    System::String ToString_NonConst();
    void AppendValues(const System::SharedPtr<System::Text::StringBuilder>& sb, bool isIntervalCondition);
    
};

} // namespace Tasks
} // namespace Aspose