company logo

ObjectSpace :: overload - Object overload option

When object overload is activated, extents in the current object space will overload extents with the same name in connected object object spaces by creating a so-called hierarchical property handle. Thus, the collection managed by the property handle contains the object instances from all instances of connected object spaces.

A connected object space is either an object space parent for a subordinated object space or an explicitly overloaded object space.

When selecting an instance, which exists in more than one of the collections involved, subordinated collections are also merged by using hierarchical subordinated properties. The existence of an instance is checked by using the currently selected key.

Deactivating or activating object space overload has no effect for property handles already opened. When opening a property handle for overloaded object spaces, a hierarchical property handle is opened. When overload is disabled, simple property handle are opened for the object space. Subordinated property handles are hierarchical property handles, when the top property handle is hierarchical and simple property handles otherwise.

By default, overloading is deactivated. When overloading an object space (overloadObjectSpace()), the overload feature is turned on.

Return value:  Overload option ( bool  )

In order to overload extents in the object space hierarchy,this option has to be set to true.

Implementation overview

Implementation details

  1. Get object overload option
    bool ObjectSpace  :: overload (  )

    The function returns whether object space overload is activated (true) or not (false).

  2. to list
  3. Set object overload option
    bool ObjectSpace  :: overload ( bool bOverload )

    The function allows activating or deactivating object space overload. Passing false in bOverload will deactivate object space overloading without disconnecting explicitly overloaded object spaces. Passing true will enable overload feature for an object space hierarchy or connected object spaces.

    When the object space is not a subordinated object space in a object space hierarchy and also not connected with another object space, the function throws an exception.

    • bOverload - Overload option

      In order to overload extents in the object space hierarchy,this option has to be set to true.

  4. to list