Object properties

Objects have a set of properties, which are values associated with the object.

Some properties, such as the type of an object, are defined for all objects. Some others are specific to a type of object.

  • Properties of an object can be retrieved using the function TM1ObjectPropertyGet.
  • Some properties can also be updated using the function TM1ObjectPropertySet.

These functions use a value pool, the handle of the object, and a property identifier as arguments. Property identifiers are returned by special functions in the API. For example, to get the name of an object, you call TM1ObjectPropertyGet, as follows:

TM1ObjectPropertyGet ( hPool, hObject, TM1ObjectName());

The TM1ObjectName function returns a property index. That index is used to specify which property you are trying to retrieve.

Properties that apply to all (or most) objects start with the prefix TM1Object. The following table shows properties that are defined for most objects.

TM1ObjectList

An array of object handles containing a list of all the children of the object of a particular type. Some objects, such as dimensions, have more than one list object associated with them. For example, dimensions have a list for subsets, and a list for hierarchies.

TM1ObjectAttributes
An array of attribute handles containing a list of all of the object's attributes.
TM1ObjectLastTimeUpdated
A TM1V containing a string. This property contains a string indicating the last time the data for this object was updated.
TM1ObjectMemoryUsed
The number of bytes of memory used by the object.
TM1ObjectName
A TM1V containing a string. This property contains the object's name.
TM1ObjectParent
The handle of the object's parent object.
TM1ObjectSecurityStatus
A TM1V containing an integer. This property contains one of the following values, as defined by the API:
  • TM1SecurityRightNone(void);
  • TM1SecurityRightRead(void);
  • TM1SecurityRightWrite(void);
  • TM1SecurityRightReserve(void);
  • TM1SecurityRightLock(void);
  • TM1SecurityRightAdmin(void);
TM1ObjectType
An integer indicating the type of object. The TM1® object type values are defined using special functions in the TM1 API. For example, the TM1 object type for a cube is returned by the function TM1TypeCube().
TM1ObjectSecurityOwner
A TM1V containing a string. This property contains the name of the client that owns the security status of the object.
TM1ObjectReplication
If this object is replicated on a server, this property contains a handle to a replication object.
TM1ObjectReplicationSourceName
The name of the source object in the star server for this object. This property is populated only if the object is replicated.
TM1ObjectRegistration
A TM1V containing an integer. This property contains one of three values, as defined by the API:

  • TM1ObjectPublic(void);

  • TM1ObjectPrivate(void);
  • TM1ObjectUnregistered(void);

Properties for specific objects start with the prefix TM1Cube, TM1Dimension, and so on.