IProcessFlowRunner interface

No description yet.

public interface IProcessFlowRunner

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
CurrentHardDevice	object	get; set

CurrentHardDevice

No description yet.

object GetCurrentHardDevice();
void SetCurrentHardDevice(object argHardDevice);

Type: object · Access: read/write

Methods

Method	Returns	Description
AddError	void
AddSummaryLine	void
FlowRunning	bool
FlowStageStarting	void
RunEnded	void
RunStarted	void

AddError

No description yet.

void AddError(string argType, string argFullErrorText);

Parameter	Type	Passing
argType	string	value
argFullErrorText	string	value

Returns: nothing (void)

AddSummaryLine

No description yet.

void AddSummaryLine(string argSection, string argKey, string argValue, string argReportPath);

Parameter	Type	Passing
argSection	string	value
argKey	string	value
argValue	string	value
argReportPath	string	value

Returns: nothing (void)

FlowRunning

No description yet.

bool FlowRunning();

Returns: bool

FlowStageStarting

No description yet.

void FlowStageStarting(IProcessFlow argStage);
void FlowStageStarting(object argStage);

Parameter	Type	Passing
argStage	IProcessFlow	value

Returns: nothing (void)

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

RunEnded

No description yet.

void RunEnded();

Returns: nothing (void)

RunStarted

No description yet.

void RunStarted();

Returns: nothing (void)

Returned by

INexusWorkbench.ProcessFlowRunner

Accepted by

IStageStateListener.Stage_Enabled, IStageStateListener.Stage_End, IStageStateListener.Stage_Info, IStageStateListener.Stage_Invalidate, IStageStateListener.Stage_Start, IToolchainManager.ExecuteBuild, IToolchainManager.ExecuteCompile, IToolchainManager.ExecuteCompileNoDep, IToolchainManager.ExecuteRebuild, IProcessFlow.Run, IProcessFlow.RunAll, IProcessFlow.RunIfOutOfDate, IProcessFlow.RunWholeStage, IProcessFlow_Internal.Dependencies_Run, IProcessFlow_Internal.Internal_Run