IPCB_ParametersFactory interface
Creates parameters, parameter lists and the parameters view of a primitive.
public interface IPCB_ParametersFactory
Namespace: PCB · Assembly: Altium.SDK.Interfaces
Remarks
GetParametersFactory of IPCB_ServerInterface returns the factory. Every call of its members returns a new object.
Methods
| Method | Returns | Description |
|---|---|---|
| CreateParameter | IPCB_Parameter | Creates a parameter with the given name, value and inherited mark. |
| CreateParameterList | IPCB_ParameterList | Creates a new, empty parameter list. |
| CreatePrimitiveParameters | IPCB_PrimitiveParameters | Returns a new IPCB_PrimitiveParameters object for a primitive, switched to the given variant. |
CreateParameter
Creates a parameter with the given name, value and inherited mark.
IPCB_Parameter CreateParameter(string argName, string argValue, bool argIsInherited);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argName | string | value | The parameter name. |
argValue | string | value | The parameter value. |
argIsInherited | bool | value | Whether the parameter is marked as inherited (IsInherited of IPCB_Parameter). |
Returns: IPCB_Parameter
Extension method of IPCB_ParametersFactoryHelper (using PCB;).
The parameter does not belong to any primitive; AddOrSetParameter of IPCB_PrimitiveParameters stores it on a primitive.
CreateParameterList
Creates a new, empty parameter list.
IPCB_ParameterList CreateParameterList();
Returns: IPCB_ParameterList
Extension method of IPCB_ParametersFactoryHelper (using PCB;).
CreatePrimitiveParameters
Returns a new IPCB_PrimitiveParameters object for a primitive, switched to the given variant.
IPCB_PrimitiveParameters CreatePrimitiveParameters(IPCB_Primitive argPrimitive, string argVariantName);
| Parameter | Type | Passing | Description |
|---|---|---|---|
argPrimitive | IPCB_Primitive | value | The primitive, for example an IPCB_Component. |
argVariantName | string | value | The variant name; [No Variations] selects the default variant and an empty string the project's current variant. |
Returns: IPCB_PrimitiveParameters
Extension method of IPCB_ParametersFactoryHelper (using PCB;).
The variant is selected as by SwitchToVariantByName of IPCB_PrimitiveParameters, which raises an error when the project has no variant of that name, or when the primitive's board is not in a project and the name is neither [No Variations] nor empty.