Class - Examples

Navigation: PGMs ➔ Classes

Functions					Subroutines		Classes
Defining a Function	Predefined Functions	Tag Functions	Mathematical Functions	String Functions	Defining a Subroutine	Trigger Subroutines	Defining a Class

Related Links: User Defined Class and Functions, Example PGM Files

Class - Introduction	Class - Defining a Class	Class - Using a Class	Class - Macros	Class - Examples

Global Predefined Class Instances: Species Database Class, Particle Size Definition Class, Plant Model Class
Predefined Classes: Array Class, StrArray Class, Matrix Class, TagSelect Class, Noise Class, TimeClass

---

Class Examples

Class Declaration Example

• A very condensed extract of the CSTR_Class PGM file is presented below to explain the structure and use of the Class definition:

Class CSTR_Class
 ClassAsPageLabel           ;example of Special Keyword
 ;... Various Variable Definitions.....
 String     UnitTag{tag}@
 Real       TankVolume*("Vol","m^3")<<300>>
 ;... Various Variable Definitions.....

 Sub Init()
   UnitTag = ClassTag()     ; example of Special Function
   [concatenate(UnitTag, ".ResTime.Volume (m^3)")] = TankVolume
 EndSub
 
 Sub CalculateCSTR()
  ;......Various Calculation Code .....
 EndSub   
 
 Sub Exec()
   ;......Various Calculation Code .....
   CalculateCSTR()                           ;Example of calling a predefined subroutine within a subroutine.
   ;......Various Calculation Code .....
 EndSub
EndClass

1. The name of the Class (or template) is called CSTR_Class.
2. All the variables that are associated with the CSTR_Class are defined. (The full PGM file is available in the Gold distributed example project)
3. Nested functions are allowed within a class, for example Sub "CalculateCSTR" is called inside the Sub "Exec()"
4. In summary, the Class(template) "CSTR_Class" contains a number of calculations and a number of Set Value Commands.

Example User Defined Classes

1. Gold Project - demonstrates the use of Classes in the CSTR pgm file. This is used to calculate the gold and copper leaching and adsorption values in a number of individual tanks.
2. Lime Preparation (Makeup) Example - demonstrates the use of two user defined Classes: Set Species Splits and Optimise Controller.
3. Milling and Flotation Project - demonstrate the use of Classes to display flotation recoveries at the end of project solve.
4. Milling and Magnetic Separation Project - demonstrate the use of Classes to display cyclone splits and magnetic separator recoveries.
5. Size Distribution Project - demonstrate the use of Classes to display some cyclone split information.
6. Digestion with Direct Heating - demonstrates the use of Classes to calculate user defined properties.
7. Demo Ammonia Project - demonstrates the use of Classes to calculate water shift.
8. SOP Example Project - demonstrate the use of Classes to add rainfall and evaporation to the tank model (emulating a pond).
9. FerroManganese Furnace Example Project - demonstrates use of Classes to set flow in feeders, perform heat loss calculations, and to calculate and set reactions extents.
10. See Example Class Files for more examples of user defined class definitions.