Libraries
Reference Source Code
 previous   up   next 

Types
reference
The type reference describes a reference to any object.

reference

const type: reference

The type reference describes a reference to any object.


Abstract data types
type
getType (in reference: aReference)
Get the type of the referenced object.

getType

const func type: getType (in reference: aReference)

Get the type of the referenced object.

Returns:
the type of the object referenced by aReference.

Constant Summary
reference
NIL
Reference to no element.

Operator Summary
reference
(attr reference) . value
Default value of reference (NIL).
boolean
(in reference: ref1) = (in reference: ref2)
Check if two references are equal.
boolean
(in reference: ref1) <> (in reference: ref2)
Check if two references are equal.

Function Summary
integer
compare (in reference: ref1, in reference: ref2)
Compare two references.
integer
hashCode (in reference: aReference)
Compute the hash value of a reference.
string
str (ref reference: aReference)
Convert a reference to a string.
void
setType (in reference: aReference, in type: aType)
Set the type of the object 'aReference' to 'aType'.

Constant Detail

NIL

const reference: NIL

Reference to no element.


Operator Detail

. value

const reference: (attr reference) . value

Default value of reference (NIL).


=

const func boolean: (in reference: ref1) = (in reference: ref2)

Check if two references are equal.

Returns:
TRUE if both references are equal, FALSE otherwise.

<>

const func boolean: (in reference: ref1) <> (in reference: ref2)

Check if two references are equal.

Returns:
FALSE if both references are equal, TRUE otherwise.

Function Detail

compare

const func integer: compare (in reference: ref1, in reference: ref2)

Compare two references.

Returns:
-1, 0 or 1 if the first argument is considered to be respectively less than, equal to, or greater than the second.

hashCode

const func integer: hashCode (in reference: aReference)

Compute the hash value of a reference.

Returns:
the hash value.

str

const func string: str (ref reference: aReference)

Convert a reference to a string.

Returns:
the string result of the conversion.
Raises:
MEMORY_ERROR - Not enough memory to represent the result.

setType

const proc: setType (in reference: aReference, in type: aType)

Set the type of the object 'aReference' to 'aType'.

Raises:
RANGE_ERROR - If 'aReference' is NIL.


 previous   up   next