1    /* 
     2     *  Copyright (c) 2008 Texas Instruments. All rights reserved. 
     3     *  This program and the accompanying materials are made available under the 
     4     *  terms of the Eclipse Public License v1.0 and Eclipse Distribution License
     5     *  v. 1.0 which accompanies this distribution. The Eclipse Public License is
     6     *  available at http://www.eclipse.org/legal/epl-v10.html and the Eclipse
     7     *  Distribution License is available at 
     8     *  http://www.eclipse.org/org/documents/edl-v10.php.
     9     *
    10     *  Contributors:
    11     *      Texas Instruments - initial implementation
    12     * */
    13    /*!
    14     *  ======== IInstance ========
    15     *  Common instance params
    16     *
    17     *  Every module's instance parameter structure contains a pointer to an
    18     *  `IInstance.Params` structure named `instance`.  So, every instance
    19     *  parameter defined in this interface may optionally be set when
    20     *  creating (or constructing) any module's instances.
    21     */
    22    interface IInstance {
    23    
    24    instance:
    25    
    26        /*! 
    27         *  ======== name ========
    28         *  Name of the instance
    29         *
    30         *  It is possible to "bind" a name to each instance of any module
    31         *  at the time the instance is created (or constructed).  
    32         *  @p(code)
    33         *      ModA_Params params;
    34         *      ModA_Params_init(&params);
    35         *      params.instance->name = "myInstance";
    36         *      ModA_create(&params, NULL);
    37         *  @p
    38         *
    39         *  The name field must be assigned a pointer to a buffer that persists
    40         *  as long as the instance that it names exists.  Only a reference to
    41         *  the name is retained in the instance, the name is not copied to a
    42         *  secondary buffer.
    43         *
    44         *  If instances have been configured to not support names, it is still
    45         *  possible to assign to the `instance.name` field of the parameter
    46         *  structure (as shown above).  However, the pointer is not retained
    47         *  and methods that normally return an instance's name will return
    48         *  `NULL` instead.
    49         */
    50        config String name = null;
    51    }
    52    /*
    53     *  @(#) xdc.runtime; 2, 1, 0,298; 1-12-2011 10:12:28; /db/ztree/library/trees/xdc/xdc-v55x/src/packages/
    54     */
    55