interface xdc.runtime.IInstance
index URL

Common instance params

Every module's instance parameter structure contains a pointer to an IInstance.Params structure named instance. So, every instance parameter defined in this interface may optionally be set when creating (or constructing) any module's instances.
XDCspec summary sourced in xdc/runtime/IInstance.xdc
interface IInstance {  ...
instance:  ...
XDCspec declarations sourced in xdc/runtime/IInstance.xdc
package xdc.runtime;
 
interface IInstance {
 
 
instance:
per-instance config parameters
    config String name// Name of the instance = null;
}
C synopsis target-domain
#include <xdc/runtime/IInstance.h>
per-instance object types
    typedef struct IInstance_Object// Client reference to an abstract instance object *IInstance_Handle;
per-instance config parameters
    typedef struct IInstance_Params// Instance config-params structure {
        String name// Name of the instance;
    } IInstance_Params;
 
 
per-instance object types
index URL

C synopsis target-domain
typedef struct IInstance_Object *IInstance_Handle;
// Client reference to an abstract instance object
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new IInstance.Params;
// Instance config-params object
    params.name = String null;
    // Name of the instance
C synopsis target-domain
typedef struct IInstance_Params {
// Instance config-params structure
    String name;
    // Name of the instance
} IInstance_Params;
 
config IInstance.name  // per-instance
index URL

Name of the instance

XDCspec declarations sourced in xdc/runtime/IInstance.xdc
config String name = null;
 
DETAILS
It is possible to "bind" a name to each instance of any module at the time the instance is created (or constructed).
      ModA_Params params;
      ModA_Params_init(&params);
      params.instance->name = "myInstance";
      ModA_create(&params, NULL);
The name field must be assigned a pointer to a buffer that persists as long as the instance that it names exists. Only a reference to the name is retained in the instance, the name is not copied to a secondary buffer.
If instances have been configured to not support names, it is still possible to assign to the instance.name field of the parameter structure (as shown above). However, the pointer is not retained and methods that normally return an instance's name will return NULL instead.
generated on Tue, 01 Sep 2009 00:36:15 GMT