IProcessFlow interface

No description yet.

public interface IProcessFlow

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Derived: ISoftwareProcessFlow

Properties

Property	Type	Access	Description
BasePath	string	get; set
ParentStage	IProcessFlow	get; set

BasePath

No description yet.

string GetBasePath();
void SetBasePath(string argPath);

Type: string · Access: read/write

ParentStage

No description yet.

IProcessFlow GetParentStage();
void SetParentStage(IProcessFlow argStage);

Type: IProcessFlow · Access: read/write

The accessors are extension methods of IProcessFlowHelper (using SCH;).

Methods

Method	Returns	Description
AddChildStage	void
AddDependency	void
CanEditProperties	bool
CanRun	bool
ClearChildren	void
ClearDependencies	void
ClearLastRunResult	void
EditProperties	void
FlowState	TProcessFlowState
GetChildStage	IProcessFlow
GetChildStageCount	int
GetDependenciesCount	int
GetDependency	IProcessFlow
InputDescription	string
IsCategory	bool
IsRunning	bool
LastRunResult	TFlowRunResult
OutputDescription	string
ProjectChanged	void
ReportCount	int
ReportPath	string
Run	TFlowRunResult
RunAll	TFlowRunResult
RunIfOutOfDate	TFlowRunResult
RunningStage	IProcessFlow
RunWholeStage	TFlowRunResult
StageCaption	string
StageDescription	string
StageName	string
Stop	void
UpdateFlowState	bool

AddChildStage

No description yet.

void AddChildStage(IProcessFlow argStage);
void AddChildStage(object argStage);

Parameter	Type	Passing
argStage	IProcessFlow	value

Returns: nothing (void)

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

AddDependency

No description yet.

void AddDependency(IProcessFlow argStage);
void AddDependency(object argStage);

Parameter	Type	Passing
argStage	IProcessFlow	value

Returns: nothing (void)

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

CanEditProperties

No description yet.

bool CanEditProperties();

Returns: bool

CanRun

No description yet.

bool CanRun();

Returns: bool

ClearChildren

No description yet.

void ClearChildren();

Returns: nothing (void)

ClearDependencies

No description yet.

void ClearDependencies();

Returns: nothing (void)

ClearLastRunResult

No description yet.

void ClearLastRunResult();

Returns: nothing (void)

EditProperties

No description yet.

void EditProperties();

Returns: nothing (void)

FlowState

No description yet.

TProcessFlowState FlowState();

Returns: TProcessFlowState

Extension method of IProcessFlowHelper (using SCH;).

GetChildStage

No description yet.

IProcessFlow GetChildStage(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IProcessFlow

Extension method of IProcessFlowHelper (using SCH;).

GetChildStageCount

No description yet.

int GetChildStageCount();

Returns: int

GetDependenciesCount

No description yet.

int GetDependenciesCount();

Returns: int

GetDependency

No description yet.

IProcessFlow GetDependency(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: IProcessFlow

Extension method of IProcessFlowHelper (using SCH;).

InputDescription

No description yet.

string InputDescription();

Returns: string

IsCategory

No description yet.

bool IsCategory();

Returns: bool

IsRunning

No description yet.

bool IsRunning();

Returns: bool

LastRunResult

No description yet.

TFlowRunResult LastRunResult();

Returns: TFlowRunResult

Extension method of IProcessFlowHelper (using SCH;).

OutputDescription

No description yet.

string OutputDescription();

Returns: string

ProjectChanged

No description yet.

void ProjectChanged(string argProjectPath);

Parameter	Type	Passing
argProjectPath	string	value

Returns: nothing (void)

ReportCount

No description yet.

int ReportCount();

Returns: int

ReportPath

No description yet.

string ReportPath(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

Run

No description yet.

TFlowRunResult Run(IProcessFlowRunner argRunner);

Parameter	Type	Passing
argRunner	IProcessFlowRunner	value

Returns: TFlowRunResult

Extension method of IProcessFlowHelper (using SCH;).

RunAll

No description yet.

TFlowRunResult RunAll(IProcessFlowRunner argRunner);

Parameter	Type	Passing
argRunner	IProcessFlowRunner	value

Returns: TFlowRunResult

Extension method of IProcessFlowHelper (using SCH;).

RunIfOutOfDate

No description yet.

TFlowRunResult RunIfOutOfDate(IProcessFlowRunner argRunner);

Parameter	Type	Passing
argRunner	IProcessFlowRunner	value

Returns: TFlowRunResult

Extension method of IProcessFlowHelper (using SCH;).

RunningStage

No description yet.

IProcessFlow RunningStage();

Returns: IProcessFlow

Extension method of IProcessFlowHelper (using SCH;).

RunWholeStage

No description yet.

TFlowRunResult RunWholeStage(IProcessFlowRunner argRunner);

Parameter	Type	Passing
argRunner	IProcessFlowRunner	value

Returns: TFlowRunResult

Extension method of IProcessFlowHelper (using SCH;).

StageCaption

No description yet.

string StageCaption();

Returns: string

StageDescription

No description yet.

string StageDescription();

Returns: string

StageName

No description yet.

string StageName();

Returns: string

Stop

No description yet.

void Stop();

Returns: nothing (void)

UpdateFlowState

No description yet.

bool UpdateFlowState();

Returns: bool

Returned by

IDeviceLink.DownloadFlow, IDeviceLink.ProcessFlow, IDeviceLink.SubversionFlow, IDeviceLink.VaultFlow, IDeviceLink.VerifyFlow, INexusDevice.FlowStage_Build, INexusDevice.FlowStage_Download, INexusDriver.FlowStage_Build, INexusDriver.FlowStage_Download

Accepted by

IProcessFlowRunner.FlowStageStarting