- Adam Duritz
Class
Class Methods
| Class() | Constructor for the Class class using a name and space |
| Class() | Constructor for the Class class using an existing Aztec object |
| Class() | Constructor for the Class class based on the class that it is called from |
| IsValid() | Returns true if this Class metadata item is valid |
| Is() | Returns true if this data type has an OO "is a" relationship with a specified class |
| IsPrimitive() | Returns true if the class is "primitive" |
| IsEnum() | Returns true if the class is an enumeration |
| IsType() | Returns true if the class/type is defined with the 'type' statement |
| IsMethodRef() | Returns true if the class/type is a method reference |
| IsBaseMethodRef() | Returns true if the class/type is a base method reference |
| ActualClass() | Returns reference to "actual" Class if it is defined with 'type' statement |
| Size() | Retuns the total size of storage needed for all data items in the class |
| NumDimensions() | Returns the number of dimensions associated with the data type (if defined with 'type') |
| GetMethods() | Returns an array of method metadata items for the class |
Derived Classes
None
See Also
Class Hierarchy, Script, Unit, Module, Method
public method Class(string Name, string Space)
Parameters
Name
Name of the Aztec class
Space
Space in which the class is defined
Return Value
None
Description
Constructor for the Class class. This implementation uses a class name and a space in which the class is defined. If the class name and space are a valid data type, the IsValid() method will return true and false if not.
Class Class
public method Class(Base Object)
Parameters
Object
Aztec object used as basis for this 'Class' object
Return Value
None
Description
Constructor for the Class class. This implementation uses an existing Aztec object to define the class used for this Class object. This constructor will always result in a valid data type, so the IsValid() method will always return true. If null is passed in for the Object, a NullArgException will be fired.
Class Class
public method Class()
Parameters
None
Return Value
None
Description
Constructor for the Class class. This implementation takes no arguments. The Class that contains the code that performs the call to this constructor will be used for this Class object. If the constructor call is made from a global method, this Class object will be marked as invalid.
Class Class
public virtual method<bool> IsValid()
Parameters
None
Return Value
True if Class represents a valid data type
Description
Virtual method which returns true if the underlying data type is valid. If the Class object was created with a name/space combination, this method will return false if the combination does not exist and true if it does exist. If created with an existing object, it will always return true.
Class Class
public method<bool> Is(Class Compare)
Parameters
Compare
Class to be compared to
Return Value
True if an "is a" relationship exists
Description
This method returns true if the data type associated with this Class object has an object oriented "is a" relationship with the Class object passed into the method and returns false if not. If either of the Class objects are not valid, this method will return false.
Class Class
public method<bool> IsPrimitive()
Parameters
None
Return Value
True if the class is primitive data
Description
This method returns true if the data type associated with this Class object is a primitive data type (int, float, string, bool or enumeration).
Class Class
public method<bool> IsEnum()
Parameters
None
Return Value
True if the class is an enumeration
Description
This method returns true if the data type associated with this Class object is an enumeration data type, which includes 'bool'.
Class Class
public method<bool> IsType()
Parameters
None
Return Value
True if the class/type was defined using 'type'
Description
This method returns true if the data type associated with this Class object was defined using the 'type' statement.
Class Class
public method<bool> IsMethodRef()
Parameters
None
Return Value
True if the class/type is a method reference
Description
This method returns true if the data type associated with this Class object is a method reference.
Class Class
public method<bool> IsBaseMethodRef()
Parameters
None
Return Value
True if the class/type is a "base" method reference
Description
This method returns true if the data type associated with this Class object is a "base" method reference.
Class Class
public method<Class> ActualClass()
Parameters
None
Return Value
Actual Class object if this class/type was defined with the 'type' statement
Description
This method returns the "actual" Class object that this class/type references if it was defined using the 'type' statement. Will be null otherwise.
Class Class
public method<int> Size()
Parameters
None
Return Value
Size needed to store all data items in the class
Description
This method returns the amount of the memory needed to store all of the data items in the class.
Class Class
public method<int> NumDimensions()
Parameters
None
Return Value
Number of dimensions associated with the class/type
Description
This method returns the number of dimensions associated with this class/type. This will only be non-zero if the data type was defined using 'type' and array braces were used in that definition.
Class Class
public method<Method[]> GetMethods()
Parameters
None
Return Value
Array of Method objects in this class
Description
This method returns an array of Method metadata objects that are contained in this class. Can be null.
Class Class