Module Base
BASE The base class for all the classes defined within MOOSE.
Global(s)
| BASE | |
| FORMATION |
Type BASE
| BASE:AddEvent(Event, EventFunction) | |
| BASE.ClassID |
The ID number of the class. |
| BASE.ClassName |
The name of the class. |
| BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace) | |
| BASE:CreateEventCrash(EventTime, Initiator) | |
| BASE:DisableEvents() | |
| BASE:E(Arguments) | |
| BASE:EnableEvents() | |
| BASE.Events | |
| BASE:F(Arguments) | |
| BASE:F2(Arguments) | |
| BASE:F3(Arguments) | |
| BASE:GetClassID() |
Get the ClassID of the class instance. |
| BASE:GetClassName() |
Get the ClassName of the class instance. |
| BASE:GetClassNameAndID() |
Get the ClassName + ClassID of the class instance. |
| BASE.Inherit(Child, Parent, self) |
This is the worker method to inherit from a parent class. |
| BASE.Inherited(Child, self) |
This is the worker method to retrieve the Parent class. |
| BASE:New() | |
| BASE:T(Arguments) | |
| BASE:T2(Arguments) | |
| BASE:T3(Arguments) | |
| BASE:onEvent(event) |
Type FORMATION
| FORMATION.Cone |
A cone formation. |
Global(s)
Type Base
Type BASE
The BASE Class
Field(s)
- BASE:AddEvent(Event, EventFunction)
-
Parameters
-
Event: -
EventFunction:
-
- BASE.ClassID
-
The ID number of the class.
- BASE.ClassName
-
The name of the class.
- BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)
-
Parameters
-
EventTime: -
Initiator: -
IniUnitName: -
place: -
subplace:
-
- BASE:CreateEventCrash(EventTime, Initiator)
-
Parameters
-
EventTime: -
Initiator:
-
- BASE:E(Arguments)
-
Log an exception
Parameter
-
Arguments:
-
- BASE:F(Arguments)
-
Parameter
-
Arguments:
-
- BASE:F2(Arguments)
-
Parameter
-
Arguments:
-
- BASE:F3(Arguments)
-
Parameter
-
Arguments:
-
- BASE:GetClassID()
-
Get the ClassID of the class instance.
Return value
#string: The ClassID of the class instance.
- BASE:GetClassName()
-
Get the ClassName of the class instance.
Return value
#string: The ClassName of the class instance.
- BASE:GetClassNameAndID()
-
Get the ClassName + ClassID of the class instance.
The ClassName + ClassID is formatted as '%s#%09d'.
Return value
#string: The ClassName + ClassID of the class instance.
- BASE.Inherit(Child, Parent, self)
-
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. -
self:
Return value
Child
-
- BASE.Inherited(Child, self)
-
This is the worker method to retrieve the Parent class.
Parameters
-
#BASE Child: is the Child class from which the Parent class needs to be retrieved. -
self:
Return value
-
- BASE:T(Arguments)
-
Parameter
-
Arguments:
-
- BASE:T2(Arguments)
-
Parameter
-
Arguments:
-
- BASE:T3(Arguments)
-
Parameter
-
Arguments:
-
- BASE:onEvent(event)
-
Parameter
-
event:
-
Type FORMATION
The Formation Class
Field(s)
- FORMATION.Cone
-
A cone formation.