IParameter interface

www.kxcad.net Home > Electronic Index > Altium(Protel) Index


Your Ad Here

Overview

The IParameter interface is a parameter object interface to an existing parameter object on a schematic sheet. There are two types of parameters – system parameters which are owned by a schematic document and parameters owned by certain schematic design objects.

A parameter is a child object of a Parameter Set, Part, Pin, Port, or Sheet Symbol object. A Parameter object has a Name property and Value property which can be used to store information, thus the parameters are a way of defining and associating information and could include strings that identify component manufacturer, date added to the document and also a string for the component's value (e.g. 100K for a resistor or 10PF for a capacitor).

Each parameter has a Unique Id assigned to it. This is used for those parameters that have been added as design rule directives. When transferring the design to the PCB document, any defined rule parameters will be used to generate the relevant design rules in the PCB. These generated rules will be given the same Unique Ids, allowing you to change rule constraints in either schematic or PCB and push the change across when performing a synchronization.

An equivalent object representation is the ISch_Parameter class in the Sch API reference.

Interface Methods

Method

Description

Function   DM_Name          : WideString;

Denotes the name of the parameter object.

Function   DM_ConfigurationName : WideString;

Returns the configuration name, that the parameter object is associated with.

Function   DM_Kind          : TParameterKind;

Denotes the specific kind that can be assigned to this parameter object. String, Boolean, Integer or float..

Function   DM_Value         : WideString;

Denotes the value placeholder for this parameter object.

Function   DM_UniqueId      : WideString;

Any parameter that is configured as a container for design rule directives need to have a unique ID that will be ported onto the corresponding PCB implementation document.

Function   DM_Description   : WideString;

Denotes the description of this parameter object.

Function   DM_NewName       : WideString;

Denotes the New Name for the parameter object, especially when there is an ECO change. You can then compare the original and new names.

Function   DM_NewValue      : WideString;

Denoes the New Value for the parameter object, especially when there is an ECO change. You can then compare the original and new values.

Function   DM_OriginalOwner : IDMObject;

This function returns the interface of the owner object this parameter object is associated with.

Function   DM_Visible       : Boolean;

Denotes whether this parameter object is visible or not.