diff --git a/doc/classes/BASE.html b/doc/classes/BASE.html new file mode 100644 index 000000000..e38ccc9b4 --- /dev/null +++ b/doc/classes/BASE.html @@ -0,0 +1,225 @@ + + + + + MOOSE + + + + +
+ +
+ +
+
+
+ + +
+ + + + + + +
+ +

Class BASE

+

BASE The base class for all the classes defined within MOOSE.

+

+ +

+

Info:

+
    +
  • Author: Flightcontrol
    • +
+ + +

Methods

+ + + + + + + + + + + + + +
BASE:New ()The base constructor.
BASE:Inherit (Child, Parent)This is the worker method to inherit from a parent class.
BASE:Inherited (Child)This is the worker method to retrieve the Parent class.
+ +
+
+ + +

Methods

+ +
+
+ + BASE:New () +
+
+ The base constructor. This is the top top class of all classed defined within the MOOSE. + Any new class needs to be derived from this class for proper inheritance. + + + +

Returns:

+
    + + BASE + + + +
+ + + +

Usage:

+
    + 
    + function TASK:New()
+ trace.f(self.ClassName)
+
+     local self = BASE:Inherit( self, BASE:New() )
+
+     -- assign Task default values during construction
+     self.TaskBriefing = "Task: No Task."
+     self.Time = timer.getTime()
+     self.ExecuteStage = _TransportExecuteStage.NONE
+
+     return self
+ end
    +
+ +
+
+ + BASE:Inherit (Child, Parent) +
+
+ This is the worker method to inherit from a parent class. + + +

Parameters:

+
    +
  • Child + is the Child class that inherits. +
    • +
  • Parent + is the Parent class that the Child inherits from. +
    • +
+ +

Returns:

+
    + + Child +
+ + + + +
+
+ + BASE:Inherited (Child) +
+
+ This is the worker method to retrieve the Parent class. + + +

Parameters:

+
    +
  • Child + BASE + is the Child class from which the Parent class needs to be retrieved. +
    • +
+ +

Returns:

+
    + + Parent + + + +
+ + + + +
+
+ + +
+
+
+generated by LDoc 1.4.3 +Last updated 2015-01-29 21:06:10 +
+
+ +