View source for Class - Examples

[[Category:PGM]]
{{Navigation|[[PGMs]]|altname=Classes}}
{{Function Header Tabs |currentpage=8}}

'''Related Links:''' [[Example_PGM_Files#User_Defined_Class_and_Functions|User Defined Class and Functions]], [[Example_PGM_Files#User_Defined_Class_and_Functions|Example PGM Files]] 
{{Class Header Tabs|currentpage=5}}
'''Global Predefined Class Instances:''' [[Species Database Class]], [[Particle Size Definition Class]], [[Plant Model Class]]<br>
'''Predefined Classes:''' [[Array Class]], [[StrArray Class]], [[Matrix Class]], [[TagSelect Class]], [[Noise Class]], [[TimeClass]]
----
{{TOC}}

== Example using Include File ==

{{PGM Class Example - calculate the Agitator Power required in a Vessel}}

==Declaring Class Instances ==

{|
|<syntaxhighlight lang="pgm">
; Declare Class instances
	CSTR_Class Tank_A, Tank_B, Tank_C, Tank_D, Tank_E, Tank_F
;-----------------------------------------------------------
;Initialise class instance
	Sub InitialiseSolution()
		ForEachSub(CSTR_Class, Init())
	EndSub
;-----------------------------------------------------------
;Execute CSTR_Class subroutines  
	ForEachSub(CSTR_Class, Exec())
</syntaxhighlight>

NOTES:
# In the above example, we have defined 6 instances of the CSTR_Class.  
# When a Class instance has been declared, SysCAD will create variables and functions for that instance. 
#*For example: For CSTR_Class Tank_C, the following variable and functions can be accessed:
#*<syntaxhighlight lang="pgm" inline> String1 = Tank_C.ClassTag()</syntaxhighlight> - returns the class instances tag name (in this case, "Tank_C" is returned as a text string variable)
#*<syntaxhighlight lang="pgm" inline> String2 = Tank_C.ClassName()</syntaxhighlight> - returns the class instance type name (in this case, "CSTR_Class" is returned as a text string variable)
#*<syntaxhighlight lang="pgm" inline> Tank_C.UnitTag </syntaxhighlight>- This is an example of the class variable.
#*<syntaxhighlight lang="pgm" inline> Tank_C.Exec() </syntaxhighlight> - This is an example of the class function.
# Use <syntaxhighlight lang="pgm" inline>ForEachSub(CSTR_Class, Exec())</syntaxhighlight> to call and execute class function/subroutine for all class instances.
#*Exec() is a user defined subroutine in the CSTR_Class (template).
|Valign=top|
[[image:CSTR_Tank_C.png]]
|}

== Declaring Class Instances in an array ==

Class instance can also be defined in an array format, for example an equivalent of the above code can be written as:

{| border="1" cellpadding="5" cellspacing="0" style="width:85%"
|-
! After 139.32530!! For earlier builds of SysCAD
|-
| Valign=top style="width:40%" |
<syntaxhighlight lang="pgm">;After Build 139.32530
const long TankCount = 7
CSTR_Class Tank[TankCount]{ez}

Sub InitialiseSolution()
    ForEachSub(Tank, Init())
EndSub
 
ForEachSub(Tank, Exec())</syntaxhighlight>

|<syntaxhighlight lang="pgm">long i
const long TankCount = 7
CSTR_Class Tank[TankCount]
ExcludeWatch Tank[0]

Sub InitialiseSolution()
     i = 1
     While (i<TankCount)
         Tank[i].Init()
         i = i + 1
     EndWhile      
EndSub
      
i = 1
While (i<TankCount)
     Tank[i].Exec()
     i = i + 1
EndWhile</syntaxhighlight>
|}

NOTES:
# Seven CSTR_Class instances are defined here, Tank 0 to Tank 6.
#* The array always starts with 0, therefore, we have intentionally defined 7 instances here and we will use Tanks 1 to 6. In our PGM code we will skip Tank 0 and start with Tank 1.
# The <syntaxhighlight lang="pgm" inline>ExcludeWatch</syntaxhighlight> Keyword instructs SysCAD '''not''' to display Tank 0.
# The <syntaxhighlight lang="pgm" inline>ExcludeClass</syntaxhighlight> Keyword instructs SysCAD '''not''' to include Tank 0 in any ForEach macro.
# If the "Init()" subroutine requires a different input parameter for each call, such as Init("tagname"), then <syntaxhighlight lang="pgm" inline>ForEachSub(Tank, Init())</syntaxhighlight> cannot be used.

==Using ForEachSub with multiple class declarations ==
Some Examples on how to use the function:

{| border="1" cellpadding="5" cellspacing="0" style="width:85%"
|-
! The following code... !! Is equivalent to...
|-
| Valign=top style="width:50%" |
<syntaxhighlight lang="pgm">CSTR_Class Tank10, Tank20
CSTR_Class Tank[3]
 
 ;Example 1:
 ;Call Exec for all instances of CSTR_Class
 ForEachSub(CSTR_Class, Exec())
 
 ;Example 2:
 ;Call Exec for all instances in Tank[] Class Array only
 ForEachSub(Tank, Exec())
 
 CSTR_Class  Tank30</syntaxhighlight>

*Note that Tank30.Exec() is not called since Tank30 it is declared after ForEachClass(CSTR_Class, Exec()).
| Valign=top style="width:50%" |
<syntaxhighlight lang="pgm">CSTR_Class Tank10, Tank20
CSTR_Class Tank[3]
 
 ;Example 1:
 ;Call Exec for all instances of CSTR_Class
 Tank10.Exec()
 Tank20.Exec()
 long i
 i = 0
 While (i<3)
     Tank[i].Exec()
     i = i + 1
 EndWhile
 
 ;Example 2:
 ;Call Exec for all instances in Tank[] Class Array
 i = 0
 While (i<3)
     Tank[i].Exec()
     i = i + 1
 EndWhile
 
CSTR_Class Tank30</syntaxhighlight>
|}


== Examples Using ClassList ==

*Example of define Class instances and Class List Separately:
<syntaxhighlight lang="pgm" >
;define Class instances
TankClass T1,T2,T3,T4,T5
;define the class list
ClassList ABC {T1,T2,T3,T4,T5}</syntaxhighlight>

*Example of defining the ClassList at the same time as the class instances declaration, can use List/L/ClassList
:<syntaxhighlight lang="pgm" inline>TankClass{List(ABC)}T1,T2,T3</syntaxhighlight>

*Examples of using the ClassList created:
<syntaxhighlight lang="pgm" >
ClassGrid ABC
ForEachSub(ABC, Init())
TotalMass = ForEach(+, ABC, Mass)</syntaxhighlight>

*Other Examples:
<syntaxhighlight lang="pgm" >
ClassList List1 {T1,T2,T3}
ClassList List2 {T4,T5}
ForEachClass(List1, Exec(true))
ForEachClass(List2, Exec(false))</syntaxhighlight>


== Other PGM Example Files using Classes ==

There are many example PGM files that uses class, these are listed on this page: [[Example_PGM_Files#PGM_Files_using_Class_and_Functions|PGM Files using Class and Functions]]

== Example User Defined Classes ==

# [[Example 25 Gold|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.
# [[Example_-_02Feature_Projects#Lime_Preparation_.28Makeup.29_Project|Lime Preparation (Makeup) Example]] - demonstrates the use of two user defined Classes: [[PGM Examples - PGM Class to Set Species Splits |Set Species Splits]] and [[PGM Example - PGM Class to assist with solving sensitive PID control loops|Optimise Controller]].
# [[Example_-_04SizeDistribution_Projects#Milling_and_Flotation_Project|Milling and Flotation Project]] - demonstrate the use of Classes to display flotation recoveries at the end of project solve.
# [[Example_-_04SizeDistribution_Projects#Milling and Magnetic Separation Project|Milling and Magnetic Separation Project]] - demonstrate the use of Classes to display cyclone splits and magnetic separator recoveries.
# [[Example_-_04SizeDistribution_Projects|Size Distribution Project]] - demonstrate the use of Classes to display some cyclone split information.
# [[Digestion_Projects#Example_1:_Digestion with Direct Heating|Digestion with Direct Heating]] - demonstrates the use of Classes to calculate user defined properties.
# [[Ammonia_Projects#Example_1:_Demo_Ammonia_Project|Demo Ammonia Project]] - demonstrates the use of Classes to calculate water shift.
# [[Example_Potash_Projects#SOP_Example_Project|SOP Example Project]] - demonstrate the use of Classes to add rainfall and evaporation to the tank model (emulating a pond).
# [[Example_65_Smelting#FerroManganese_Furnace_Example|FerroManganese Furnace Example Project]] - demonstrates use of Classes to set flow in feeders, perform heat loss calculations, and  to calculate and set reactions extents.
# See [[Example_PGM_Files#PGM_Files_using_Class_and_Functions | Example Class Files]] for more examples of user defined class definitions.