IDL_Object::_overloadSize

The IDL_Object::_overloadSize function method returns a vector of values representing the object’s “dimensions”.

This method is designed to replicate the default behavior of objects that do not use operator overloading. As a result, object classes that do inherit from the IDL_Object class but that do not override this particular method will behave in the same manner as object classes that do not inherit from the IDL_Object class.

Tip: If you write an object class that inherits from IDL_Object and overloads this method, you can call the superclass method directly to achieve the default behavior for specific cases.

Syntax

In most cases, this method is called explicitly to provide information about an object’s dimensions. When called explicitly, the syntax is:

Result = Obj->[IDL_Object::]_overloadSize( )

Return Value

This method is called by the SIZE and N_ELEMENTS functions when they are called with a scalar object that inherits from the IDL_Object class, but that does not implement its own _overloadSize function method. The return value replicates the behavior of calling the SIZE or N_ELEMENTS functions with an object that does not inherit from the IDL_Object class.

Arguments

None

Keywords

None

Routine Signature

To overload this function method for an object class, implement a method with the following signature:

FUNCTION class::_overloadSize

The return value of this function should be a vector of up to eight elements containing the object “dimensions” (represented as non-negative integers). (You can define what constitutes a dimension for your object in any way you choose.)

Version History

8.0	Introduced