A BuildStep that can spawn multiple BuildStep. Input and output tracking and merging will be performed. Various input/output and output/output conflicts are detected, if WaitBuildStep is not used properly. More...

Inheritance diagram for SiliconStudio.BuildEngine.EnumerableBuildStep:

Classes
struct	InputObject

Public Member Functions
override async Task< ResultStatus >	Execute (IExecuteContext executeContext, BuilderContext builderContext)
	Execute the BuildStep, usually resulting in scheduling tasks in the scheduler More...

Public Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
virtual void	Clean (IExecuteContext executeContext, BuilderContext builderContext, bool deleteOutput)
	Clean the build, deleting the command cache which is used to determine wheither a command has already been executed, and deleting the output objects if asked. More...

abstract BuildStep	Clone ()
	Clone this Build Step. More...

abstract override string	ToString ()

Task< BuildStep >	ExecutedAsync ()

IEnumerable< IDictionary < ObjectUrl, OutputObject > >	GetOutputObjectsGroups ()

Public Attributes
readonly IEnumerable< ObjectUrl >	InputUrls

Protected Member Functions
	EnumerableBuildStep ()

	EnumerableBuildStep (IEnumerable< BuildStep > steps)

ResultStatus	ComputeResultStatusFromExecutedSteps ()
	Determine the result status of an execution of enumeration of build steps. More...

async Task	CompleteCommands (IExecuteContext executeContext, List< BuildStep > buildStepsToWait)
	Wait for given build steps to finish, then processes their inputs and outputs. More...

Protected Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
	BuildStep (ResultStatus status=ResultStatus.NotProcessed)

Protected Attributes
readonly Dictionary< ObjectUrl, OutputObject >	outputObjects = new Dictionary<ObjectUrl, OutputObject>()

readonly Dictionary< ObjectUrl, InputObject >	inputObjects = new Dictionary<ObjectUrl, InputObject>()

Protected Attributes inherited from SiliconStudio.BuildEngine.BuildStep
readonly List< CommandBuildStep >	SpawnedStepsList = new List<CommandBuildStep>()

Properties
override string	Title `[get]`

IDictionary< ObjectUrl, OutputObject >	OutputObjects `[get]`

IEnumerable< BuildStep >	Steps `[get, set]`

Properties inherited from SiliconStudio.BuildEngine.BuildStep
string	Module `[get, set]`
	Gets or sets the module associated with this build step, used when logging error/information. More...

int	Priority `[get, set]`
	Gets or sets the priority amongst other build steps. More...

abstract string	Title `[get]`
	Title of the build step. Intended to be short More...

string	Description `[get]`
	Description of the build step. Intended to be longer and more descriptive than the Title More...

ResultStatus	Status `[get, set]`
	The status of the result. More...

bool	Processed `[get]`
	Indicate whether this command has already been processed (ie. executed or skipped) by the Builder More...

bool	Succeeded `[get]`
	Indicate whether the result corresponds to a successful execution (even if the command has not been triggered) More...

bool	Failed `[get]`
	Indicate whether the result corresponds to a failed execution (even if the command has not been triggered) More...

object	Tag `[get, set]`
	A tag property that can contain anything useful for tools based on this build Engine. More...

IEnumerable< BuildStep >	PrerequisiteSteps `[get]`
	List of commands that must be executed prior this one (direct dependence only). More...

IEnumerable< CommandBuildStep >	SpawnedSteps `[get]`
	List of commands that needs this command to be successfully executed before being processed More...

BuildStep	Parent `[get, set]`
	The parent build step, which will be the instigator of the step More...

long	ExecutionId `[get, set]`
	An unique id during a build execution, assigned once the build step is scheduled. More...

bool	ArePrerequisitesCompleted `[get]`
	Indicate whether all prerequisite commands have been processed More...

bool	ArePrerequisitesSuccessful `[get]`
	Indicate whether all prerequisite commands have been processed and are in a successful state More...

Additional Inherited Members
Static Public Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
static void	LinkBuildSteps (BuildStep parent, BuildStep child)

Events inherited from SiliconStudio.BuildEngine.BuildStep
EventHandler< BuildStepEventArgs >	StepProcessed
	Event raised when the command is processed (even if it has been skipped or if it failed) More...

Detailed Description

A BuildStep that can spawn multiple BuildStep. Input and output tracking and merging will be performed. Various input/output and output/output conflicts are detected, if WaitBuildStep is not used properly.

Definition at line 17 of file EnumerableBuildStep.cs.

Constructor & Destructor Documentation

SiliconStudio.BuildEngine.EnumerableBuildStep.EnumerableBuildStep ( )

protected

Definition at line 33 of file EnumerableBuildStep.cs.

SiliconStudio.BuildEngine.EnumerableBuildStep.EnumerableBuildStep ( IEnumerable< BuildStep > steps )

protected

Definition at line 38 of file EnumerableBuildStep.cs.

Member Function Documentation

async Task SiliconStudio.BuildEngine.EnumerableBuildStep.CompleteCommands	(	IExecuteContext	executeContext,
		List< BuildStep >	buildStepsToWait
	)

protected

Wait for given build steps to finish, then processes their inputs and outputs.

Parameters

executeContext	The execute context.
buildStepsToWait	The build steps to wait.

Returns

Definition at line 106 of file EnumerableBuildStep.cs.

ResultStatus SiliconStudio.BuildEngine.EnumerableBuildStep.ComputeResultStatusFromExecutedSteps ( )

protected

Determine the result status of an execution of enumeration of build steps.

Returns: The result status of the execution.

Definition at line 72 of file EnumerableBuildStep.cs.

override async Task<ResultStatus> SiliconStudio.BuildEngine.EnumerableBuildStep.Execute	(	IExecuteContext	executeContext,
		BuilderContext	builderContext
	)

virtual

Execute the BuildStep, usually resulting in scheduling tasks in the scheduler

Parameters

executeContext	The execute context
builderContext	The builder context

Returns: A task returning ResultStatus indicating weither the execution has successed or failed.

Implements SiliconStudio.BuildEngine.BuildStep.

Reimplemented in SiliconStudio.BuildEngine.FileEnumerationBuildStep, and SiliconStudio.BuildEngine.OutputEnumerationBuildStep.

Definition at line 43 of file EnumerableBuildStep.cs.

Member Data Documentation

readonly Dictionary<ObjectUrl, InputObject> SiliconStudio.BuildEngine.EnumerableBuildStep.inputObjects = new Dictionary<ObjectUrl, InputObject>()

protected

Definition at line 28 of file EnumerableBuildStep.cs.

readonly IEnumerable<ObjectUrl> SiliconStudio.BuildEngine.EnumerableBuildStep.InputUrls

Definition at line 29 of file EnumerableBuildStep.cs.

readonly Dictionary<ObjectUrl, OutputObject> SiliconStudio.BuildEngine.EnumerableBuildStep.outputObjects = new Dictionary<ObjectUrl, OutputObject>()

protected

Definition at line 25 of file EnumerableBuildStep.cs.

Property Documentation

IDictionary<ObjectUrl, OutputObject> SiliconStudio.BuildEngine.EnumerableBuildStep.OutputObjects

get

Definition at line 26 of file EnumerableBuildStep.cs.

IEnumerable<BuildStep> SiliconStudio.BuildEngine.EnumerableBuildStep.Steps

getset

Definition at line 31 of file EnumerableBuildStep.cs.

override string SiliconStudio.BuildEngine.EnumerableBuildStep.Title

get

Definition at line 20 of file EnumerableBuildStep.cs.

The documentation for this class was generated from the following file:

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/common/buildengine/SiliconStudio.BuildEngine.Common/EnumerableBuildStep.cs

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation