Поддержка вычисления функций в формулах

Aspose.Tasks для .NET API поддерживает вычисление функций, определённых как формулы внутри расширенных атрибутов проекта.
Это позволяет разработчикам выполнять вычисления, похожие на те, что доступны в Microsoft Project, что делает возможной реализацию динамических полей, зависящих от пользовательской логики.

API предоставляет поддержку вычисления для следующих категорий функций:

• Математические функции
• Общие функции
• Текстовые функции
• Функции даты/времени

Эта функция особенно полезна, когда необходимо:

• Автоматизировать расчёты проекта,
• Внедрять пользовательские бизнес-правила,
• Обеспечить совместимость формул между MS Project и Aspose.Tasks.

Вычисление математических выражений

Поддерживаются следующие математические функции:

1. Abs( number )
2. Atn( number )
3. Cos( number )
4. Exp( number )
5. Fix( number )
6. Int( number )
7. Log( number )
8. Rnd( number )
9. Sgn( number )
10. Sin( number )
11. Sqr( number )
12. Tan( number )

static void EvaluateSine()
{
    Project project = CreateTestProjectWithCustomField();
    
    // Set formula Sin(pi/2)
    project.ExtendedAttributes[0].Formula = "Sin(3.1415926/2)";

    // Print Calculated value
    Task task = project.RootTask.Children.GetById(1);
    Console.WriteLine("Sin(pi/2): {0}", task.ExtendedAttributes[0].NumericValue);
}

static Project CreateTestProjectWithCustomField()
{
    Project project = new Project();
    ExtendedAttributeDefinition attr = ExtendedAttributeDefinition.CreateTaskDefinition(CustomFieldType.Number, ExtendedAttributeTask.Number1, "Sine");
    project.ExtendedAttributes.Add(attr);

    Task task = project.RootTask.Children.Add("Task");

    ExtendedAttribute a = attr.CreateExtendedAttribute();
    task.ExtendedAttributes.Add(a);
    return project;
}

Вычисление общих функций

Следующие функции выполняют логические и условные вычисления:

1. Choose( index, choice-1, choice-2, ... , choice-n ) – выбирает значение из списка.
2. IIf( expr, truepart, falsepart ) – возвращает одно из двух значений в зависимости от условия.
3. IsNumeric( expression ) – проверяет, является ли выражение числовым.
4. IsNull( expression ) – проверяет, является ли выражение null.
5. Switch( expr-1, value-1, expr-2, value-2, ... ) – последовательно вычисляет выражения и возвращает первое соответствующее значение.

static void EvaluateChoose()
{    
    Project project = CreateTestProjectWithCustomField();
    
    // Set Formula
    project.ExtendedAttributes[0].Formula = "Choose(3, \"This is a\", \"right\", \"choice\")";
    
    // Print extended attribute value
    Task task = project.RootTask.Children.GetById(1);
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
}

static void EvaluateIsNumeric()
{
    string[] numericFormulas = { "IsNumeric('AAA')", "IsNumeric(1)", "IsNumeric(1<0)", "IsNumeric(\"1.1\")", "IsNumeric(Choose((2 + Sgn(2^-3)), 123, \"one two three\"))" };
    
    Project project = CreateTestProjectWithCustomField();
    
    foreach (string numericFormula in numericFormulas)    
    {
        // Set Formula
        project.ExtendedAttributes[0].Formula = numericFormula;

        // Print extended attribute value
        Task task = project.RootTask.Children.GetById(1);
        Console.WriteLine(task.ExtendedAttributes[0].TextValue);
    }
}

static void EvaluateSwitch()
{    
    Project project = CreateTestProjectWithCustomField();

    // Set Formula
    project.ExtendedAttributes[0].Formula = "Switch( 0 < 1, \"0 is lesser than 1\", 0 > 1, \"0 is greater than 1\")";

    // Print extended attribute value
    Task task = project.RootTask.Children.GetById(1);
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
}

Вычисление текстовых функций

Функции обработки строк позволяют форматировать и сравнивать:

1. Asc( string ) – возвращает ASCII-код первого символа.
2. Chr( charcode ) – возвращает символ для заданного ASCII-кода.
3. Format( expression, format, firstdayofweek, firstweekofyear ) – форматирует числа/даты.
4. Instr( start, string1, string2, compare ) – находит позицию одной строки внутри другой.
5. LCase( string ) – преобразует в строчные буквы.
6. Left( string, length ) – извлекает символы слева.
7. Len( string ) – возвращает длину строки.
8. LTrim( string ) – удаляет ведущие пробелы.
9. Mid( string, start, length ) – извлекает подстроку.
10. Right( string, length ) – извлекает символы справа.
11. RTrim( string ) – удаляет конечные пробелы.
12. Space( number ) – возвращает строку с пробелами.
13. StrComp( string1, string2, compare ) – сравнивает две строки.
14. StrConv( string, conversion, LCID ) – преобразует строку в соответствии с локалью.
15. String( number, character ) – возвращает строку, повторённую n раз.
16. Trim( string ) – удаляет ведущие и конечные пробелы.
17. UCase( string ) – преобразует в заглавные буквы.

static void EvaluateStrConv()
{
    Project project = CreateTestProjectWithCustomField();
    Task task = project.RootTask.Children.GetById(1);

    // Set formulas and print extended attribute value
    project.ExtendedAttributes[0].Formula = "StrConv(\"sTring and sTRINg\",3)";
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
    project.ExtendedAttributes[0].Formula = "StrConv(\"sTring and sTRINg\",1)";
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
    project.ExtendedAttributes[0].Formula = "StrConv(\"sTring and sTRINg\",2)";
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
}

static void EvaluateStringFunction()
{
    Project project = CreateTestProjectWithCustomField();
    Task task = project.RootTask.Children.GetById(1);

    // Set formulas and print extended attribute value
    project.ExtendedAttributes[0].Formula = "String(5, 40)";
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
    project.ExtendedAttributes[0].Formula = "String(5, \"A\")";
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
    project.ExtendedAttributes[0].Formula = "String(-5, \"A\")";
    // #Error
    Console.WriteLine(task.ExtendedAttributes[0].TextValue);
}

Вычисление функций даты/времени

Aspose.Tasks поддерживает как стандартные функции даты в стиле VB, так и функции планирования, специфичные для MS Project:

1. CDate( expression ) – преобразует выражение в дату.
2. Date() – возвращает текущую системную дату.
3. DateAdd( interval, number, date ) – прибавляет интервал к дате.
4. DateDiff( interval, date1, date2 ) – разница между двумя датами.
5. DatePart( interval, date ) – извлекает часть даты (год, месяц, день и т.д.).
6. DateSerial( year, month, day ) – формирует дату из компонентов.
7. DateValue( date ) – преобразует строку в дату.
8. Day( date ) – день месяца.
9. Hour( time ) – извлекает час.
10. IsDate( expression ) – проверяет, является ли выражение допустимой датой.
11. Minute( time ) – извлекает минуты.
12. Month( date ) – извлекает месяц.
13. Now() – возвращает текущую дату и текущее время.
14. ProjDateAdd( date, duration, calendar ) – добавляет длительность с учётом календаря проекта.
15. ProjDateConv( expression, dateformat ) – преобразует дату в формат проекта.
16. ProjDateDiff( date1, date2, calendar ) – разница с учётом календаря проекта.
17. ProjDateSub( date, duration, calendar ) – вычитает длительность.
18. ProjDateValue( expression ) – вычисляет выражение даты.
19. ProjDurConv( expression, durationunits ) – преобразует длительности между единицами измерения.
20. ProjDurValue( duration ) – вычисляет выражение длительности.
21. Second( time ) – извлекает секунды.
22. Time() – возвращает текущее системное время.
23. Timer() – количество секунд с полуночи.
24. TimeSerial( hour, minute, second ) – формирует значение времени.
25. TimeValue( time ) – преобразует в время.
26. Weekday( date, firstdayofweek ) – возвращает день недели.
27. Year( date ) – извлекает год.

Project project = CreateTestProject();
Task task = project.RootTask.Children.GetById(1);

ExtendedAttributeDefinition numberDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Number1, null);
project.ExtendedAttributes.Add(numberDefinition);

ExtendedAttribute numberAttribute = numberDefinition.CreateExtendedAttribute();
task.ExtendedAttributes.Add(numberAttribute);

// Set ProjDateDiff formula and print extended attribute value
numberDefinition.Formula = "ProjDateDiff(\"03/23/2015\",\"03/18/2015\")";
Console.WriteLine(numberAttribute.NumericValue);
numberDefinition.Formula = "ProjDateDiff(\"03/23/2015\",\"03/25/2015\")";
Console.WriteLine(numberAttribute.NumericValue);

ExtendedAttributeDefinition dateDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Date1, null);
project.ExtendedAttributes.Add(dateDefinition);
ExtendedAttribute dateAttribute = dateDefinition.CreateExtendedAttribute();
task.ExtendedAttributes.Add(dateAttribute);

ExtendedAttributeDefinition durationDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Duration4, "Custom duration field");
project.ExtendedAttributes.Add(durationDefinition);
ExtendedAttribute durationAttribute = durationDefinition.CreateExtendedAttribute();
task.ExtendedAttributes.Add(durationAttribute);

ExtendedAttributeDefinition textDefinition = ExtendedAttributeDefinition.CreateTaskDefinition(ExtendedAttributeTask.Text5, "Custom text field");
project.ExtendedAttributes.Add(textDefinition);
ExtendedAttribute textAttribute = textDefinition.CreateExtendedAttribute();
task.ExtendedAttributes.Add(textAttribute);

// Set ProjDateSub formula and print extended attribute value
dateDefinition.Formula = "ProjDateSub(\"3/19/2015\", \"1d\")";
Console.WriteLine(dateAttribute.DateValue);

// We can set ProjDurConv formula to duration-valued attribute as well as to text-valued attribute.

// Set ProjDurConv formula to duration-valued extended attribute and print its value.
durationDefinition.Formula = "ProjDurConv([Duration], pjHours)";
Console.WriteLine(durationAttribute.DurationValue);

// Set ProjDurConv formula to text-valued extended attribute and print its value.
textDefinition.Formula = "ProjDurConv([Duration], pjHours)";
Console.WriteLine(textAttribute.TextValue);

textDefinition.Formula = "ProjDurConv([Duration], pjWeeks)";
Console.WriteLine(textAttribute.TextValue);

// Set Second formula and print entended attribute value
numberDefinition.Formula = "Second(\"4/21/2015 2:53:41 AM\")";
Console.WriteLine(numberAttribute.NumericValue);

// Set Weekday formula and print entended attribute value
numberDefinition.Formula = "Weekday(\"24/3/2015\", 1)";
Console.WriteLine(numberAttribute.NumericValue);
numberDefinition.Formula = "Weekday(\"24/3/2015\", 2)";
Console.WriteLine(numberAttribute.NumericValue);
numberDefinition.Formula = "Weekday(\"24/3/2015\", 3)";
Console.WriteLine(numberAttribute.NumericValue);

Практический пример

Пример практического применения формул:

    var project = new Project();
    var task = project.RootTask.Children.Add("Task 1");

    // Create an extended attribute with a custom formula
    ExtendedAttributeDefinition attrDef = ExtendedAttributeDefinition.CreateTaskDefinition(
        ExtendedAttributeTask.Text1, "Custom Formula");
        attrDef.Formula = "IIf([Duration] > 480, \"Long Task\", \"Short Task\")";
        project.ExtendedAttributes.Add(attrDef);

    var attr = attrDef.CreateExtendedAttribute();
    task.ExtendedAttributes.Add(attr);

    // The formula is automatically evaluated by Aspose.Tasks
    Console.WriteLine(task.Get(Tsk.Name) + " -> " + task.ExtendedAttributes[0].TextValue);

Ключевые преимущества поддержки формул

• Полная совместимость с формулами MS Project.
• Возможность автоматизировать динамические поля и условную логику.
• Встроенная поддержка для функций, учитывающих календарь проекта (ProjDateAdd, ProjDateDiff и др.).
• Упрощает сложные вычисления без написания пользовательского кода на C#.

См. также

• Работа с расширенными атрибутами
• Работа с формулами
• Работа с вычислениями проекта