IToolchainManager interface

No description yet.

public interface IToolchainManager

Namespace: Embedded · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
OptionsStore	IOptionsStorage	get; set
Toolchain	string	get; set

OptionsStore

No description yet.

IOptionsStorage GetOptionsStore();
void SetOptionsStore(IOptionsStorage argOptionsStore);

Type: IOptionsStorage · Access: read/write

The accessors are extension methods of IToolchainManagerHelper (using Embedded;).

Toolchain

No description yet.

string GetToolchain();
void SetToolchain(string argToolchainName);

Type: string · Access: read/write

Methods

Method	Returns	Description
AddStageStateListener	void
AfterRename	void
BeforeRename	void
CheckToolchainValid	bool
ChildDocumentRename	void
ConvertMacros	string
ExecuteBuild	bool
ExecuteCompile	bool
ExecuteCompileNoDep	bool
ExecuteRebuild	bool
GetFilesWithOptionsDialog	IToolchainManagerGenericOptionDlg
GetOptionDefaultValue	string
GetOptionsDialog	IToolchainManagerOptionDlg
GetProcessor	string
GetProductDirectory	string
GetProjectExecutableFilesPaths	string
GetProjectIncludeFilesPaths	string
GetProjectLibraryFilesPaths	string
GetProjectSwPlatformPath	string
GetToolCmdOption	string
InvalidateToolchain	void
IsReady	bool
ISRunning	bool
RegenerateMakefile	void
SetAdditionalOutputDir	void
SetDocumentName	void
SetModified	void
SetProjectName	void
SetStageCreatedListener	void
SetUseErrFile	void
SetUseLogicalDocuments	void
SetUseProgressDialog	void
ShowOptionsDialog	void
StopExecution	void
UpdateStageState	void
UpdateToolchainFromDevice	void

AddStageStateListener

No description yet.

void AddStageStateListener(IStageStateListener argListener);
void AddStageStateListener(object argListener);

Parameter	Type	Passing
argListener	IStageStateListener	value

Returns: nothing (void)

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

AfterRename

No description yet.

void AfterRename();

Returns: nothing (void)

BeforeRename

No description yet.

void BeforeRename();

Returns: nothing (void)

CheckToolchainValid

No description yet.

bool CheckToolchainValid(bool argIgnoreAllowed);

Parameter	Type	Passing
argIgnoreAllowed	bool	value

Returns: bool

ChildDocumentRename

No description yet.

void ChildDocumentRename(string argOldName, string argNewName);

Parameter	Type	Passing
argOldName	string	value
argNewName	string	value

Returns: nothing (void)

ConvertMacros

No description yet.

string ConvertMacros(string argSource);

Parameter	Type	Passing
argSource	string	value

Returns: string

ExecuteBuild

No description yet.

bool ExecuteBuild(IProcessFlowRunner argProcessFlowRunner);
bool ExecuteBuild(object argProcessFlowRunner);

Parameter	Type	Passing
argProcessFlowRunner	IProcessFlowRunner	value

Returns: bool

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

ExecuteCompile

No description yet.

bool ExecuteCompile(string argSourceDocument, string argToolId, IProcessFlowRunner argProcessFlowRunner);
bool ExecuteCompile(string argSourceDocument, string argToolId, object argProcessFlowRunner);

Parameter	Type	Passing
argSourceDocument	string	value
argToolId	string	value
argProcessFlowRunner	IProcessFlowRunner	value

Returns: bool

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

ExecuteCompileNoDep

No description yet.

bool ExecuteCompileNoDep(string argSrcDocFullPath, string argToolId, IProcessFlowRunner argProcessFlowRunner);
bool ExecuteCompileNoDep(string argSrcDocFullPath, string argToolId, object argProcessFlowRunner);

Parameter	Type	Passing
argSrcDocFullPath	string	value
argToolId	string	value
argProcessFlowRunner	IProcessFlowRunner	value

Returns: bool

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

ExecuteRebuild

No description yet.

bool ExecuteRebuild(IProcessFlowRunner argProcessFlowRunner);
bool ExecuteRebuild(object argProcessFlowRunner);

Parameter	Type	Passing
argProcessFlowRunner	IProcessFlowRunner	value

Returns: bool

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

GetFilesWithOptionsDialog

No description yet.

IToolchainManagerGenericOptionDlg GetFilesWithOptionsDialog();

Returns: IToolchainManagerGenericOptionDlg

Extension method of IToolchainManagerHelper (using Embedded;).

GetOptionDefaultValue

No description yet.

string GetOptionDefaultValue(string argnOptionID);

Parameter	Type	Passing
argnOptionID	string	value

Returns: string

GetOptionsDialog

No description yet.

IToolchainManagerOptionDlg GetOptionsDialog(string argFileName, string argFocusedToolId);

Parameter	Type	Passing
argFileName	string	value
argFocusedToolId	string	value

Returns: IToolchainManagerOptionDlg

Extension method of IToolchainManagerHelper (using Embedded;).

GetProcessor

No description yet.

string GetProcessor();

Returns: string

GetProductDirectory

No description yet.

string GetProductDirectory();

Returns: string

GetProjectExecutableFilesPaths

No description yet.

string GetProjectExecutableFilesPaths();

Returns: string

GetProjectIncludeFilesPaths

No description yet.

string GetProjectIncludeFilesPaths();

Returns: string

GetProjectLibraryFilesPaths

No description yet.

string GetProjectLibraryFilesPaths();

Returns: string

GetProjectSwPlatformPath

No description yet.

string GetProjectSwPlatformPath();

Returns: string

GetToolCmdOption

No description yet.

string GetToolCmdOption(string argToolId, string argSource);

Parameter	Type	Passing
argToolId	string	value
argSource	string	value

Returns: string

InvalidateToolchain

No description yet.

void InvalidateToolchain();

Returns: nothing (void)

IsReady

No description yet.

bool IsReady(bool argIgnoreAllowed);

Parameter	Type	Passing
argIgnoreAllowed	bool	value

Returns: bool

ISRunning

No description yet.

bool ISRunning();

Returns: bool

RegenerateMakefile

No description yet.

void RegenerateMakefile();

Returns: nothing (void)

SetAdditionalOutputDir

No description yet.

void SetAdditionalOutputDir(string argRelativeToOut);

Parameter	Type	Passing
argRelativeToOut	string	value

Returns: nothing (void)

SetDocumentName

No description yet.

void SetDocumentName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: nothing (void)

SetModified

No description yet.

void SetModified();

Returns: nothing (void)

SetProjectName

No description yet.

void SetProjectName(string argName);

Parameter	Type	Passing
argName	string	value

Returns: nothing (void)

SetStageCreatedListener

No description yet.

void SetStageCreatedListener(IStageCreatedListener argListener);
void SetStageCreatedListener(object argListener);

Parameter	Type	Passing
argListener	IStageCreatedListener	value

Returns: nothing (void)

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

SetUseErrFile

No description yet.

void SetUseErrFile(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SetUseLogicalDocuments

No description yet.

void SetUseLogicalDocuments(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

SetUseProgressDialog

No description yet.

void SetUseProgressDialog(bool argValue);

Parameter	Type	Passing
argValue	bool	value

Returns: nothing (void)

ShowOptionsDialog

No description yet.

void ShowOptionsDialog(string argFileName, string argFocusedToolId);

Parameter	Type	Passing
argFileName	string	value
argFocusedToolId	string	value

Returns: nothing (void)

StopExecution

No description yet.

void StopExecution();

Returns: nothing (void)

UpdateStageState

No description yet.

void UpdateStageState();

Returns: nothing (void)

UpdateToolchainFromDevice

No description yet.

void UpdateToolchainFromDevice(string argDeviceName);

Parameter	Type	Passing
argDeviceName	string	value

Returns: nothing (void)