Name: | Class |
Version: | 1.0 |
ID: | ID_CLASS |
Status: | Stable |
Category: | System |
Date: | May 2001 |
Author: | Rocklyte Systems |
Copyright: | Rocklyte Systems (c) 1996-2001. All rights reserved. |
Short: | The Master Class manages all classes in the Pandora Engine. |
The "Class" lies at the root of the system design and is responsible for managing the construction of new classes. All classes that are dynamically created within the system are represented by Class objects. If necessary, you can inspect these objects to discover detailed information about each class that has been loaded. Most of the interesting structural data can be gleaned from the Fields field.
A number of functions are available in the object kernel for the purpose of class management. The kernel maintains its own list of Class objects, which you can search by calling the FindClass() function. The CheckAction() function provides a way of checking if a particular pre-defined action is supported by a class.
Classes are almost always encapsulated by shared modules, although it is possible to create private classes inside executable programs. For information on the creation of classes, refer to the Class Development Guide for a complete run-down on class development.
Keep in mind that if you want to create an official (publicly available) class, you will need to register it with Rocklyte Systems so that its use can be promoted to other developers. To register, write to devsupport@rocklyte.com with details on the class that you want to create.
The Class object consists of the following public fields:
ActionTable This field can be read to retrieve a Class object's internal action table. Actions Set this field to define the actions supported by the class. BaseClassID Specifies the base class ID of a Class object. Category Defines the category that a Class object belongs to. Fields Points to a field array that describes the Class' object structure. FileDescription Describes the file type represented by the Class. FileExtension Describes the file extension represented by the Class. Flags Optional flag settings. Methods Set this field to define the methods supported by the Class. Name The name of the Class. OpenCount Indicates the total amount of active objects that are linked back to the Class. Size The total size of the object structure represented by the Class. SubClassID Specifies the sub-class ID of a Class object. TotalFields Read this field to get the total number of fields defined by a Class. TotalMethods Read this field to get the total number of methods supported by a Class. Version The version number of the Class.
Field: | Actions | |
Short: | Set this field to define the actions supported by the class. | |
Type: | struct ActionArray * | |
Status: | Init | |
|
Field: | BaseClassID | |
Short: | Specifies the base class ID of a Class object. | |
Type: | LONG | |
Status: | Read/Init | |
|
Field: | Category | |||||||||||||||||||||||
Short: | Defines the category that a Class object belongs to. | |||||||||||||||||||||||
Type: | LONG | |||||||||||||||||||||||
Prefix: | CCF_ | |||||||||||||||||||||||
Status: | Read/Init | |||||||||||||||||||||||
|
Field: | Fields | |
Short: | Points to a field array that describes the Class' object structure. | |
Type: | struct FieldArray * | |
Status: | Read/Init | |
|
Field: | FileDescription | |
Short: | Describes the file type represented by the Class. | |
Type: | STRING | |
Status: | Read/Init | |
|
Field: | FileExtension | |
Short: | Describes the file extension represented by the Class. | |
Type: | STRING | |
Status: | Read/Init | |
|
Field: | Flags | |||||||||
Short: | Optional flag settings. | |||||||||
Type: | LONG/FLAGS | |||||||||
Prefix: | CLF | |||||||||
Status: | Read/Init | |||||||||
|
Field: | Methods | |
Short: | Set this field to define the methods supported by the Class. | |
Type: | struct MethodArray * | |
Status: | Get/Set | |
|
Field: | Name | |
Short: | The name of the Class. | |
Type: | STRING | |
Status: | Read/Init | |
|
Field: | OpenCount | |
Short: | Indicates the total amount of active objects that are linked back to the Class. | |
Type: | LONG | |
Status: | Read | |
|
Field: | Size | |
Short: | The total size of the object structure represented by the Class. | |
Type: | LONG | |
Status: | Read/Init | |
|
Field: | SubClassID | |
Short: | Specifies the sub-class ID of a Class object. | |
Type: | LONG | |
Status: | Read/Init | |
|
Field: | TotalFields | |
Short: | Read this field to get the total number of fields defined by a Class. | |
Type: | LONG | |
Status: | Read | |
|
Field: | TotalMethods | |
Short: | Read this field to get the total number of methods supported by a Class. | |
Type: | LONG | |
Status: | Read | |
|
Field: | Version | |
Short: | The version number of the Class. | |
Type: | FLOAT | |
Status: | Read/Init | |
|