ALPHABETICAL LISTING OF CLASSES
In the following summaries, information is not given about throws of Type_Check_Failure. Assume that if a method requires a parameter to be of a certain type, it will throw Type_Check_Failure if the parameter is not of that type.
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Class type: |
exception |
Include file: |
ddelegat.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an invalid argument range, such as a negative argument to the square root function |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an invalid argument range, such as a negative argument to the square root function |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an overflow condition in an atom variable. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate wrong data. |
Class type: |
abstract |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Base class for all standard library containers. |
Instance property: |
Data (private) A sequence which contains the actual container data. |
Instance methods: |
clone#0 (normal public) Overrides method from Entity to allow public copying of instances. |
|
Count#0 (final public) Returns the number of elements in the container. |
|
delete#0 (normal public) Overrides method from Entity to allow public destruction of instances. |
|
Find#1 (normal public) Returns the position in the container of the parameter if it is found, otherwise NIL. If multiple copies of the parameter are found, returns the first (lowest) position. |
|
Find_Last#1 (normal public) Same as Find#1, but if multiple copies of the parameter are found, returns the last (highest) position. |
|
Get#0 (normal public) Returns the last element in the container. |
|
Get#1 (normal protected) Returns the element of the container in the position specified by the parameter, which must be an integer. Negative parameters indicate positions starting from the end of the container. If the container is empty, throws Container_Empty; if the parameter does not specify a valid position, throws Type_Check_Failure. If an exception is thrown, returns NIL. |
|
Get_Data#0 (normal protected) Returns Data. (Used for efficiency in some subclasses.) |
|
Insert#1 (normal public) Inserts the parameter at the end of the container. |
|
Insert#2 (normal protected) The second parameter (which must be an integer) specifies the position in the container where the first parameter is to be inserted (negative parameters count from the end of the container), specify zero or one more than the container's count to insert at the end). Throws Bad_Parameter if the second parameter does not specify a valid position. Returns NIL. |
|
Remove#0 (normal public) Removes and returns the last element of the container. If the container is empty, throws Container_Empty and returns NIL. |
|
Remove#1 (normal protected) Removes and returns the element of the container at the position specified by the parameter, which must be an integer. If the parameter does not specify a valid position, throws Type_Check_Failure. If the container is empty, throws Container_Empty. If an exception is thrown, returns NIL. |
|
Set#2 (normal protected) The second parameter (which must be an integer) specifies the position in the sequence where the first parameter is to be inserted, replacing the current element (negative parameters count from the end of the container). Throws Type_Check_Failure if the second parameter does not specify a valid position. If the container is empty throws Container_Empty. Returns NIL. |
Class method: |
new#0 (normal public) Overrides method from Entity to allow public creation of instances. |
Class type: |
exception |
Include file: |
dwidget.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an instance is being used as a value of one of its own properties, or two or more instances value references to each other as property values (A is a property value of B and B is a property value of A; A is a property value of B, B is a property value of C, and C is a property value of A, etc.). Circular_Reference would be thrown when this condition is an error. (Many circular references are not errors.) |
Class type: |
interface |
Include file: |
diamond.e |
Package: |
Diamond Kernel |
Description: |
Identifies classes whose instances are publicly clonable. |
Instance method: |
clone#0 Should clone its target instance, returning the clone. In case of failure, return Null_Instance. |
Class type: |
normal |
Include file: |
dwidget.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Provides Visual Basic style collections. The collection contains components of a specified class (or its subclasses) which are identified by name, and can be accessed by name or by position in the collection. Two examples of where collections might be useful: In a database program, to define a database as a collection of tables; in a GUI program, to define a window as a collection of widgets. |
Instance properties: |
Component_Class (private) Indicates the class of component that may be stored in the collection. This class must be Component or one of its subclasses. |
|
Components (private) An Indexed_Sequence which maintains the list of components. |
Inherited instance properties: |
From Component: Collection, Name |
Instance methods: |
Count#0 (final public) Returns the number of components in the collection. |
|
delete#0 (normal public) Calls Remove#1 for each component in the collection, then deletes Components. Returns the target instance's class. |
|
Find#1 (final public) If a component with the name given by the parameter is in the collection, returns its position. If not, returns the negative of the position where a component of that name would be inserted. |
|
Get#0 (final public) Returns the last component in the collection. |
|
Get#1 (final public) If the parameter is an integer, returns the component at that position in the collection (negative integers count from the end); if the parameter is a string, returns the component with that name in the collection. If the parameter does not specify a valid component, throws Type_Check_Failure and returns Null_Instance. |
|
Get_Component_Class#0 (final public) Returns Component_Class. |
|
Insert#1 (final public) Overrides method inherited from Component. If the parameter is an instance of the collection's allowable class, inserts the component into the collection; otherwise throws Type_Check_Failure. If the insertion would result in duplicate names, it is canceled and Duplicate_Element is thrown. After a successful insertion, invokes the component's Set_Collection#0 method. Returns NIL. |
|
Remove#0 (final public) Removes and returns the last component in the collection, proceeding as in Remove#1. |
|
Remove#1 (final public) Overrides method inherited from Component. The parameter can be a component name or an integer index (negative integers count from the end). If the collection is empty, throws Container_Empty. If the name is not found or the index is not valid, throws Type_Check_Failure. If an exception is thrown, returns Null_Instance; if not removes the component specified by the parameter, invokes the removed component's Set_Collection#0 method (unless the removed component's Collection instance property is Null_Instance) and returns the removed component. |
Inherited instance methods: |
From Component: Clone#0, Set_Collection#0 |
Class methods: |
new#1 (normal public) Same as new#2, setting the Component_Class instance property to Component. |
|
new#2 (normal public) The first parameter is an identifier which will give the name of the Collection, the second element must be an entity is a subclass of Component . (Component itself may be used to create a collection that will accept any component.) The name is passed to the superclass method new#1. The class of second parameter becomes the allowable class for the collection. If the second parameter is an instance, it becomes the first component in the collection. Returns the newly created instance, or returns Null_Instance if an exception is thrown.. |
Inherited class methods: |
From Component: new#0 |
Inherited instance events: |
From Component: Insert#0, Remove#0 |
Class type: |
abstract |
Include file: |
dwidget.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interface: |
|
Description: |
The base class for all components which can be included in collections. |
Instance properties: |
Collection (public private) A Collection instance which specifies the collection in which the component is included. If the component is not included in a collection, this will be Null_Instance. |
|
Name (public private) An identifier which specifies the name of the component. |
Instance methods: |
delete#0 (normal protected) If Collection is not Null_Instance, sets Collection to Null_Instance then invokes Collection's Remove#1 method, passing the target instance's Name property as the parameter. Returns Null_Instance. |
|
Set_Collection#0 (final public) If Collection is Null_Instance, and last() is an instance of Collection, sets Collection to last() and raises the target's Insert#0 event. If Collection is equal to last(), sets Collection to Null_Instance and raises the target's Remove#0 event. In all other cases, acts as a null method. Returns NIL. |
Inherited instance method: |
From Entity: clone#0 |
Class methods: |
new#0 (normal protected) Null method to prevent creation of components without supplying a name. Returns Null_Instance. |
|
new#1 (normal protected) Creates a component with a name given by the parameter, which must be an identifier. Returns the newly created instance or returns Null_Instance if an exception is thrown.. |
Instance events: |
Insert#0 (protected private) Raised from Set_Collection#0 method. |
|
Remove#0 (protected private) Raised from Set_Collection#0 method. |
Class type: |
normal |
Include file: |
dvar.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interface: |
|
Description: |
Provides reference constants which generate events when read or initialized. |
Inherited instance properties: |
From Variable: Data, Initialized, Type_Check |
Instance method: |
Set#1 (normal public) Overrides method inherited from Variable. If Initialized is TRUE, throws Initialized_Constant and returns, otherwise calls the superclass method. Returns NIL. |
Inherited instance methods: |
From Variable: clone#0, delete#0, Get#0, Uninitialize#0, Uninitialize#1 |
Inherited class method: |
|
Inherited instance events: |
From Variable: Get#1, Set#2 |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error occurring in a new class method of a class. |
Class type: |
interface |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Defines the essential methods for full-access containers. |
Instance methods: |
Find#1 Should determine if the parameter is an element of the container; if so, return the element's position; if not, return 0 for unsorted containers or the negative of the position at which the parameter would be inserted for sorted containers. |
|
Get#1 Should return the element of the container specified by the parameter. |
|
Remove#1 Should remove and return the element of the container specified by the parameter. |
Inherited instance methods: |
From Minimal_Container: Count#0, Get#0, Insert#1, Remove#0 |
Class type: |
exception |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate that a container is empty when it is expected to have one or more elements. |
Class type: |
exception |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error using a container. Typically, one of its subclasses would be thrown. |
Class type: |
exception |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate that limited capacity container is allready full when an attempt is made to add a new element. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error occurring in a clone instance method of a class. |
Class type: |
abstract |
Include file: |
ddelegat.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interface: |
|
Description: |
Provides C# style delegates. Wraps a single property, method, or event of a single entity for indirect access. Delgates may be poassed as parameters, used in callbacks, etc. |
Instance properties: |
Name (private) An identifier giving the name of the property, method, or event wrapped by the instance. |
|
Param_Count (private) The number of parameters taken by the wrapped method or event. For a wrapped property this will be 0. |
|
Target (private) The wrapped entity. |
|
Type (private) One of the following constants,
indicating what type of delegate:
|
Instance methods: |
Call#1 (normal public) If Type is DELEGATE_METHOD, calls the wrapped method using the parameter as the method’s parameter list and returns its value; otherwise throws Wrong_Delegate_Type and returns NIL. |
|
clone#0 (normal public) Overrides method inherited
from Entity to provide public access. |
|
delete#0 (normal public) Overrides method inherited from Entity to provide public access. |
|
Get#0 (normal public) If Type is DELEGATE_PROPERTY or DELGATE_PROPERTY_GET, returns the wrapped property value; otherwise throws Wrong_Delegate_Type and returns NIL. |
|
Link#1 (normal public) If Type is DELGATE_EVENT or DELEGATE_EVENT_LINK,
links the handler or handlers specified by the parameter to the linked event;
otherwise throws Wrong_Delegate_Type.
Returns NIL. |
|
Raise#1 (normal public) If Type is DELEGATE_EVENT or
DELGATE_EVENT_RAISE, raises the wrapped event using the parameter as the
event’s parameter list; otherwise throws Wrong_Delegate_Type. Returns NIL. |
|
Set#1 (normal public) If Type is DELEGATE_PROPERTY or
DELEGATE_PROPERTY_SET, sets the wrapped property to the value specified by
the parameter; otherwise throws Wrong_Delegate_Type. Returns NIL. |
Class methods: |
new#0 (normal protected) Null method to prevent creation of delegates without the required parameters. Returns Null_Instance. |
|
new#3 (normal public) Calls new#4, passing 0 as the parameter count. |
|
new#4 (normal public) Creates a new delegate. The first parameter is the value of Type; the second is the target entity to be wrapped; the third is the name of the property, method, or event to be wrapped; the fourth is the parameter count, which must be a non-negative integer and must be 0 for a property. The ability access the property, method, event is checked via can_get(), etc. If the property, method, or event is not accessible, throws Access_Denied and returns Null_Instance. |
Notes: |
The Delegate class can only wrap public properties, methods, and events. This is easily worked around by the use of inner classes. If you need to wrap a protected property, method, or event of your class, define a subclass of Delegate as an inner class of your class. If you need to wrap a private property, method, or event, define your class as an inner class of a subclass of Delegate. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error occurring in a delete instance method of an class. |
Class type: |
interface |
Include file: |
diamond.e |
Package: |
Diamond Kernel |
Description: |
A tag interface with no methods which identifies classes whose instances cannot be cloned. |
Class type: |
exception |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an attempt to add an element to a container which duplicates an element already in the container, when this would constitute an error |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an end of file condition. |
Class type: |
abstract |
Include file: |
diamond.e |
Package: |
Diamond Kernel |
Description: |
Universal base class. |
Instance methods: |
clone#0 (normal protected) Creates a shallow copy of its target instance and returns it. |
|
delete#0 (normal protected) Destroys its target instance and returns Null_Instance. |
Class method: |
new#0 (normal protected) Creates and returns a new instance of its target class. |
Class type: |
exception |
Include file: |
diamond.e |
Package: |
Diamond Kernel |
Description: |
The base class of the exception hierarchy. Virtually never thrown, often used in catch() to catch all exceptions. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error occurring during file handling. Typically, one of its subclasses would be thrown. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error locking a file. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error opening a file. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error reading from a file. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error writing to a file. |
Class type: |
normal |
Include file: |
dcontain.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Interfaces: |
|
Description: |
Identical to Sorted_Sequence except that each element must be a sequence and the sorting is done by a pre-selected element of the sequence, rather than the entire element. |
Instance properties: |
Include_Index (private) A boolean, indicating whether the index field is included in the element (record). Defaults to TRUE. |
|
Index (private) An integer indicating which element of the sequence values is to be the index of the sequence. Defaults to 1. |
|
Records (private) A sequence of the elements (records), kept parallel to Data, which maintains the indexes. |
Inherited instance properties: |
From Sorted_Sequence:
Descending, Ignore_Case, Unique |
Instance methods: |
Get#1 (normal public) Overrides method inherited from Sorted_Sequence. Returns the element with the index included or not as indicated by Include_Index. |
|
Insert#1 (normal public) Overrides method inherited from Sorted_Sequence. Throws Type_Check_Failure if the parameter (which must be a sequence) has a length less than the index element, otherwise invokes the superclass method, passing the index as the parameter. |
|
Remove#0 (normal public) Overrides method inherited from Sorted_Sequence. Removes and returns the last element with the index included or not as indicated by Include_Index. |
|
Remove#1 (normal public) Overrides method inherited from Sorted_Sequence. Removes and returns the element with the index included or not as indicated by Include_Index. |
Inherited instance methods: |
From Sorted_Sequence:
Find#1, Find_Last#1, Get_Data#0 |
Class methods: |
new#4 (normal public) Creates a new instance. The first three parameters are passed to Sorted_Sequence's new#3 class method. The fourth parameter is a positive integer specifying the value of the Index instance property. Returns the new instance. Returns Null_Instance if an exception is thrown. |
|
new#5 (normal public) Creates a new instance. The first three parameters are passed to Sorted_Sequence's new#3 class method. The fourth parameter is a positive integer specifying the value of the Index instance property, the fifth parameter is a boolean specifying the value of Include_Index. Returns the new instance. Returns Null_Instance if an exception is thrown. |
Inherited class methods: |
From Sorted_Sequence: new#0, new#1, new#2, new#3 |
Class type: |
exception |
Include file: |
dvar.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Indicates an attempt to set an already initialized constant. |
Class type: |
abstract |
Include file: |
dsingle.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Provides classes whose instances are counted. |
Class property: |
Instances (protected read, private write) Contains the number of instances of the class currently in existence. Initialized to 0. |
Instance methods: |
clone#0 (normal protected) Overrides method inherited from Entity. Clones its target and increments Instances. |
|
delete#0 (normal protected) Overrides method inherited from Entity. Deletes its target and decrements Instances. |
Class methods: |
new#0 (normal protected) Overrides method inherited from Entity. Creates a new instance and increments Instances. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
Overflow |
Description: |
Can be used to indicate an overflow condition in an integer variable. |
Class type: |
exception |
Include file: |
dexcept.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Can be used to indicate an error in the internal operation of a method. |
Class type: |
abstract |
Include file: |
dsingle.e |
Package: |
Diamond Standard Class Library |
Superclass: |
|
Description: |
Provides classes which can only have a limited number of instances. |
Class property: |
Limit (protected read, private write) Contains the maximum number of instances of the class allowed to exist at the same time. |
Inherited class property: |
From Instance_Counted: Instances |
Instance method: |
clone#0 (normal protected) Overrides method inherited from Instance_Counted. Clones its target unless this would result in Limit being exceeded, then throws Too_Many_Instances and returns Null_Instance. |
Inhertied instance method: |
From Instance_Counted: delete#0 |
Class methods: |
Limit#0 (normal private) Called by Initialize#0, returns 0. Subclasses should override this method to return the allowable number of instances for the class. |
|
Initialize#0 (normal protected). Calls Limit#0 and sets Limit to its return value. (Sets Limit to zero if the return value is negative or not an integer.) |
|
new#0 (normal protected) Overrides method inherited from Entity. Creates a new instance unless this would result in Limit being exceeded, then throws Too_Many_Instances and returns Null_Instance. |