IParameterVariation interface

The IParameterVariation interface represents the component that contains parameter variations. Physically, there is only one PCB document with components that are specified. So for each output requirement, each document variant is generated, although there is only one PCB design document.

public interface IParameterVariation : IDMObject

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Inherits: IDMObject

Methods

Method	Returns	Description
DM_CalculatedValue	string
DM_ParameterName	string	Denotes the name of the parameter that the component is associated with.
DM_SetParameterName	void
DM_SetVariedValue	void
DM_VariedValue	string	Denotes the value of the parameter that the component is associated with.

DM_CalculatedValue

No description yet.

string DM_CalculatedValue(IComponent argComponent, IComponentVariation argComponentVariation);
string DM_CalculatedValue(object argComponent, object argComponentVariation);

Parameter	Type	Passing
argComponent	IComponent	value
argComponentVariation	IComponentVariation	value

Returns: string

The first overload is an extension method of IParameterVariationHelper (using EDP;) with typed parameters; the second is declared by the interface.

DM_ParameterName

Denotes the name of the parameter that the component is associated with.

string DM_ParameterName();

Returns: string

Examples: Extension_BOMManager

DM_SetParameterName

No description yet.

void DM_SetParameterName(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

Examples: Extension_AddVariant

DM_SetVariedValue

No description yet.

void DM_SetVariedValue(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

Examples: Extension_AddVariant

DM_VariedValue

Denotes the value of the parameter that the component is associated with. A component variant can have parameter variants.

string DM_VariedValue();

Returns: string

Examples: Extension_BOMManager

Inherited members

• From IDMObject: DM_CalculateParameterValue, DM_CurrentSheetInstanceNumber, DM_FullCrossProbeString, DM_GeneralField, DM_GetVCSProject, DM_ImageIndex, DM_IsFormulaString, DM_IsInferredObject, DM_LocationString, DM_LocationX, DM_LocationY, DM_LongDescriptorString, DM_NetIndex_Flat, DM_NetIndex_Sheet, DM_NetIndex_SubNet, DM_ObjectKindString, DM_ObjectKindStringForCrossProbe, DM_OwnerDocument, DM_OwnerDocumentFullPath, DM_OwnerDocumentName, DM_ParameterCount, DM_Parameters, DM_PcbHandle, DM_PCBObjectHandle, DM_PCBObjectInterface, DM_PrimaryCrossProbeString, DM_SchHandle, DM_SCHObjectHandle, DM_SCHObjectInterface, DM_SecondaryCrossProbeString, DM_SetVCSProject, DM_SheetIndex_Logical, DM_SheetIndex_Physical, DM_ShortDescriptorString, DM_ValidForNavigation, DM_VHDLEntity

Returned by

IComponentVariation.DM_AddParameterVariation, IComponentVariation.DM_FindParameterVariation, IComponentVariation.DM_Variations

Examples

Used in the SDK examples: Extension_AddVariant.