Documentation for SOOP API Library v1.0
Table of Contents

Object Low Level Routines

Low level routines that deal with the Object Enviroment


These functions allow for accessing the Object Enviroment, and is mainly meant for use internally by the library. Do not use without express knowledge of the internal workings of the SOOP Library. They are provided without warranty.

  • func soop_OBJ_ClassIX( sObx Instance )   Returns the Class Instance associated with an Object.
  • func soop_OBJ_EnumMembers( sObj Instance )   Returns a List of Members on an Object.
  • func soop_OBJ_MemberVal( sObj Instance, eAtom MemberInstance )   Returns the Value of a Member on an Object.
  • func soop_OBJ_Num()   Returns the Number of objects in memory

    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_OBJ_ClassIX
    ( sObx Instance )

    Returns the Class Instance associated with an Object.

    Returns: Class Instance

    Category: Object Low Level Routines

    This function returns the Class Instance assigned to an object given. It allows for faster retrival of certian aspects, such a Member Types.

    See Also: soop_OBJ_EnumMembers, soop_OBJ_MemberVal, soop_OBJ_Num


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_OBJ_EnumMembers
    ( sObj Instance )

    Returns a List of Members on an Object.

    Returns: Sequence of Members

    Category: Object Low Level Routines

    This returns the names of the Members on a Object, for debugging information. It returns the Current List of members defined on an object.

    See Also: soop_OBJ_ClassIX, soop_OBJ_MemberVal, soop_OBJ_Num


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_OBJ_MemberVal
    ( sObj Instance, eAtom MemberInstance )

    Returns the Value of a Member on an Object.

    Returns: Value of Member

    Category: Object Low Level Routines

    This function allows the faster retrival of Member data on an object, mainly because there isn't as much overhead in this function, as there is with oget(). It was mainly used for the Debug System, so that as much speed could be gained without having to resort to the oget() function.

    See Also: soop_OBJ_ClassIX, soop_OBJ_EnumMembers, soop_OBJ_Num


    Documentation for SOOP API Library v1.0
    Table of Contents

    [func]
    soop_OBJ_Num
    ()

    Returns the Number of objects in memory

    Returns: Integer representing the number of Objects

    Category: Object Low Level Routines

    This returns the Number of Objects in Memory, for faster access to each object. It was primarly developed for the SOOP Debug Class, so that it could debug the Object Enviroment.

    See Also: soop_OBJ_ClassIX, soop_OBJ_EnumMembers, soop_OBJ_MemberVal