Page Comparison

...

Launching the Code Editor

Creating Code Filters

1. In the Destinations Rules Step click the Codes Filters button.

2. The Block Filter Code Editor dialog will appear, where you can add a new code filter and manage with it as described below.

...

Code Filter Toolbar items

Button	Description
Image Modified	Add a new Code Filter
Image Modified	Remove selected Code Filter
Image Modified	Move selected Code Filter Up or Down in the list
Image Modified	Load in Code Filter from file
Image Modified	Save selected Code Filter
Image Modified	Save all Code Filters within the project

Code Editor panel

The Code Editor panel is where the Code Filters are written. It comprises a toolbar, text editor, and two helper tabs (Formulas and Errors) located down the bottom.

Toolbar

Button	Description
Image Modified	Compiles the code. If any errors are present, errors will be displayed in the Errors tab located at the bottom of the editor.
Image Modified	Undo <CTRL + Z> or Redo <CTRL + Y> previous actions

Text Editor

The text editor is where the code for the filters is written.

...

The Formulas tab contains a list of helper functions that can be used to help construct Code Filters. They are designed to provide a high level of abstraction to the user and make creating Code Filters easier by reducing the amount of code needed to be written.

...

...

The sole objective of this Code Filter is to determine whether the Fe and SiO2 of mined HG blocks fall within the given cut off values. To achieve this, we need to create variables to store the address of the Fe and SiO2 fields so we can retrieve the values. We also need to create two variables to store the calendar inputs so we can enter the cut-off values.

...

Step 3 - Create Calendar Inputs

In the previous step, we defined two CustomCalendarInput variables. We now need to assign values to those variables, and this done in the CreateCalendarInputs method. The easiest way to achieve this is outlined below.

1. Within the CreateCalendarInputs method, grab a variable “_feCutOff” and place an assignment operator (=) on the right-hand side.

2. Select and double click on the Generate CalendarInput formula from the Available Formulas list.

...

3. Fill out the required inputs and once completed, press OK.

...

Configure Generate CalendarInput dialog items

Name	Description
Names	Name structure for additional calendar field. Names will be nested under one another

Image Removed

Image Added
Default Value	The default value shown in the calendar field when new periods are created
Minimum Value	The minimum value allowed to be entered into the field by the user
Maximum Value	The maximum value allowed to be entered into the field by the user
Display Format	The format in which data is displayed in the calendar

4. Review the code which was inserted and edit it, if required.

...

In the Step 2, we declared two variables that were intended to store the address of the Fe and the SiO2 database fields. Just like the Custom Calendar variables, we need to assign values to these variables. The easiest way to achieve this is outlined below.

1. Within the CreateFieldRefernce method, grab a reference variable “_feGrade” and place an assignment operator (=) on the right-hand side.

2. Select and double click on the Create Mining Double Field Reference formula from the Available Formulas list.

...

3. Select the relevant field from the dropdown list and press OK.

...

In the use case example, we want to determine if the Fe value of the block is greater than the Fe cut-off value and if the SiO2 value is less than the silica cut off. This can be achieved by the following.

1. Grab the Fe value of the block using the “_feGrade” variable and the variable “b” (scheduling block).

2. Grab the user-defined cut-off value from the calendar using the “_feCutOff” variable.

3. Use a boolean expression to check if the Fe value is greater than the cut-off value.

4. Store the result of the boolean expression in a local variable.

5. Repeat steps 1-4 for SiO2.

6. Use a boolean expression on resultant variables created in the Step 4.

...

Step 6 - Applying the Code Filter

...

using System;
using Alastri.Patri.V2;
using Alastri.TotalScheduler.ScriptExtensions;
using Alastri.TotalScheduler.ScriptExtensions.Modifiers;
using System.Collections.Generic;
using Alastri.Scripting;
using Alastri.SchedulingCore;


public class SimpleProductionBlockFilterSample : SimpleProductionBlockFilter
{
	//Variables to store the database adress of the grade fields
    private IProductionDoubleReference _feGrade;
	private IProductionDoubleReference _siO2Grade;
	
	//Variables to store the additional calendar input
    private CustomCalendarInput _feCutOff;
	private CustomCalendarInput _siO2CutOff;

    public override void CreateCalendarInputs(CalendarInputContext context)
    {
		_feCutOff = context.CreateCalendarInput(new InputTemplate
        {
            Names = new string[]{"Code Filters", "Fe SiO2", "Fe"},
            DefaultValue = -1,
            MinValue = -1,
            MaxValue = 100,
            Format = "#,##0.00",
        });
        
        _siO2CutOff = context.CreateCalendarInput(new InputTemplate
        {
            Names = new string[]{"Code Filters", "Fe SiO2", "SiO2"},
            DefaultValue = -1,
            MinValue = -1,
            MaxValue = 100,
            Format = "#,##0.00",
        });
    }

    public override void CreateFieldReferences(FieldReferenceContext context)
    {
        _feGrade = context.GetMiningDoubleReference("grades_Fe");
		_siO2Grade = context.GetMiningDoubleReference("grades_Sio2");
    }

    public override bool Include(IProductionSchedulingBlock b)
    {
		double feValue = _feGrade.GetValue(b); //Get the Fe value from the block
		double feCutOffValue = _feCutOff.Value; //Get the cut-off value from the calendar
		bool fePass = feValue >= feCutOffValue; //Compare the two values
		
		double siO2Value = _siO2Grade.GetValue(b); //Get the SiO2 value from the block
		double siO2CutOffValue = _siO2CutOff.Value; //Get the cut-off value from the calendar
		bool siO2Pass = siO2Value <= siO2CutOffValue; //Compare the two values
		
		//Returns True if both fePass and siO2Pass are True, else it returns False  
        return fePass & siO2Pass;
    }
}

...

Раздел документации на русском языке 🇷🇺