IComponentConfigurator interface

No description yet.

public interface IComponentConfigurator

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
ConfiguratorName	string	get

ConfiguratorName

No description yet.

string GetState_ConfiguratorName();

Type: string · Access: read-only

Methods

Method	Returns	Description
AreConfigurableParametersEquivalent	bool
ConfigureComponent	bool
ConfigureComponentParametrically	bool
GenerateNetlist	bool
GenerateNetlist_1	bool
GenerateReport	string
GenerateSoftwareCode	bool
GetConfigurationValues	string
GetParameters	string
GetParametersFromPart	string
Import_FromDialog	void
IsChildCoreUsed	bool
IsChildCoreUsedByPart	bool
IsVerilogSupported	bool
SetConfigurationParametersToDefault	void
UpdateSymbol	bool

AreConfigurableParametersEquivalent

No description yet.

bool AreConfigurableParametersEquivalent(string argEncodedParamString, string argBEncodedParamString);

Parameter	Type	Passing
argEncodedParamString	string	value
argBEncodedParamString	string	value

Returns: bool

ConfigureComponent

No description yet.

bool ConfigureComponent(ISch_Component argSchComponent);
bool ConfigureComponent(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: bool

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

ConfigureComponentParametrically

No description yet.

bool ConfigureComponentParametrically(ISch_Component argSchComponent, string argParamString);
bool ConfigureComponentParametrically(object argSchComponent, string argParamString);

Parameter	Type	Passing
argSchComponent	ISch_Component	value
argParamString	string	value

Returns: bool

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

GenerateNetlist

No description yet.

bool GenerateNetlist(string argParameters, string argFileName);

Parameter	Type	Passing
argParameters	string	value
argFileName	string	value

Returns: bool

GenerateNetlist_1

No description yet.

bool GenerateNetlist_1(string argParameters, string argExtendedParams, string argFileName);

Parameter	Type	Passing
argParameters	string	value
argExtendedParams	string	value
argFileName	string	value

Returns: bool

GenerateReport

No description yet.

string GenerateReport(ISch_Component argSchComponent);
string GenerateReport(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: string

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

GenerateSoftwareCode

No description yet.

bool GenerateSoftwareCode(string argInstanceName, string argConfigurationValues, IEmbeddedCode argHeaderFile, IEmbeddedCode argSourceFile);
bool GenerateSoftwareCode(string argInstanceName, string argConfigurationValues, object argHeaderFile, object argSourceFile);

Parameter	Type	Passing
argInstanceName	string	value
argConfigurationValues	string	value
argHeaderFile	IEmbeddedCode	value
argSourceFile	IEmbeddedCode	value

Returns: bool

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

GetConfigurationValues

No description yet.

string GetConfigurationValues(ISch_Component argSchComponent);
string GetConfigurationValues(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: string

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

GetParameters

No description yet.

string GetParameters(ISch_Component argSchComponent);
string GetParameters(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: string

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

GetParametersFromPart

No description yet.

string GetParametersFromPart(IPart argPart);
string GetParametersFromPart(object argPart);

Parameter	Type	Passing
argPart	IPart	value

Returns: string

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

Import_FromDialog

No description yet.

void Import_FromDialog(ref string argEncodedParamString);

Parameter	Type	Passing
argEncodedParamString	string	ref

Returns: nothing (void)

IsChildCoreUsed

No description yet.

bool IsChildCoreUsed(string argChildCoreName, ISch_Component argSchComponent);
bool IsChildCoreUsed(string argChildCoreName, object argSchComponent);

Parameter	Type	Passing
argChildCoreName	string	value
argSchComponent	ISch_Component	value

Returns: bool

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

IsChildCoreUsedByPart

No description yet.

bool IsChildCoreUsedByPart(string argChildCoreName, IPart argPart);
bool IsChildCoreUsedByPart(string argChildCoreName, object argPart);

Parameter	Type	Passing
argChildCoreName	string	value
argPart	IPart	value

Returns: bool

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

IsVerilogSupported

No description yet.

bool IsVerilogSupported();

Returns: bool

SetConfigurationParametersToDefault

No description yet.

void SetConfigurationParametersToDefault(ISch_Component argSchComponent);
void SetConfigurationParametersToDefault(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: nothing (void)

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

UpdateSymbol

No description yet.

bool UpdateSymbol(ISch_Component argSchComponent);
bool UpdateSymbol(object argSchComponent);

Parameter	Type	Passing
argSchComponent	ISch_Component	value

Returns: bool

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

Returned by

IConfiguratorManager.GetConfigurator