Підтримка обчислення функцій у формулах

Aspose.Tasks for .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#.

Див. також

• Робота з розширеними атрибутами
• Робота з формулами
• Робота з розрахунками проекту