Inheritance diagram for SiliconStudio.BuildEngine.BuildStep:

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

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 ()

Static Public Member Functions
static void	LinkBuildSteps (BuildStep parent, BuildStep child)

Protected Member Functions
	BuildStep (ResultStatus status=ResultStatus.NotProcessed)

Protected Attributes
readonly List< CommandBuildStep >	SpawnedStepsList = new List<CommandBuildStep>()

Properties
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...

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

Detailed Description

Definition at line 11 of file BuildStep.cs.

Constructor & Destructor Documentation

SiliconStudio.BuildEngine.BuildStep.BuildStep ( ResultStatus status = ResultStatus.NotProcessed )

protected

Definition at line 13 of file BuildStep.cs.

Member Function Documentation

virtual void SiliconStudio.BuildEngine.BuildStep.Clean	(	IExecuteContext	executeContext,
		BuilderContext	builderContext,
		bool	deleteOutput
	)

virtual

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.

Parameters

executeContext	The execute context
builderContext	The builder context
deleteOutput	if true, every output object is also deleted, in addition of the command cache.

Reimplemented in SiliconStudio.BuildEngine.CommandBuildStep.

Definition at line 120 of file BuildStep.cs.

abstract BuildStep SiliconStudio.BuildEngine.BuildStep.Clone ( )

pure virtual

Clone this Build Step.

Returns

Implemented in SiliconStudio.BuildEngine.DynamicBuildStep, SiliconStudio.BuildEngine.CommandBuildStep, SiliconStudio.BuildEngine.FileEnumerationBuildStep, SiliconStudio.BuildEngine.OutputEnumerationBuildStep, SiliconStudio.BuildEngine.ListBuildStep, SiliconStudio.Paradox.Assets.Effect.PermutationGeneratorBuildStep, and SiliconStudio.BuildEngine.WaitBuildStep.

abstract Task<ResultStatus> SiliconStudio.BuildEngine.BuildStep.Execute	(	IExecuteContext	executeContext,
		BuilderContext	builderContext
	)

pure 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.

Implemented in SiliconStudio.BuildEngine.CommandBuildStep, SiliconStudio.BuildEngine.FileEnumerationBuildStep, SiliconStudio.BuildEngine.OutputEnumerationBuildStep, SiliconStudio.BuildEngine.EnumerableBuildStep, SiliconStudio.BuildEngine.DynamicBuildStep, and SiliconStudio.BuildEngine.WaitBuildStep.

Task<BuildStep> SiliconStudio.BuildEngine.BuildStep.ExecutedAsync ( )

Definition at line 143 of file BuildStep.cs.

IEnumerable<IDictionary<ObjectUrl, OutputObject> > SiliconStudio.BuildEngine.BuildStep.GetOutputObjectsGroups ( )

Definition at line 179 of file BuildStep.cs.

static void SiliconStudio.BuildEngine.BuildStep.LinkBuildSteps	(	BuildStep	parent,
		BuildStep	child
	)

static

Definition at line 135 of file BuildStep.cs.

abstract override string SiliconStudio.BuildEngine.BuildStep.ToString ( )

pure virtual

Implemented in SiliconStudio.BuildEngine.DynamicBuildStep, SiliconStudio.BuildEngine.CommandBuildStep, SiliconStudio.BuildEngine.ListBuildStep, SiliconStudio.BuildEngine.WaitBuildStep, SiliconStudio.BuildEngine.FileEnumerationBuildStep, SiliconStudio.Paradox.Assets.Effect.PermutationGeneratorBuildStep, and SiliconStudio.BuildEngine.OutputEnumerationBuildStep.

Member Data Documentation

readonly List<CommandBuildStep> SiliconStudio.BuildEngine.BuildStep.SpawnedStepsList = new List<CommandBuildStep>()

protected

Definition at line 78 of file BuildStep.cs.

Property Documentation

bool SiliconStudio.BuildEngine.BuildStep.ArePrerequisitesCompleted

get

Indicate whether all prerequisite commands have been processed

Definition at line 94 of file BuildStep.cs.

bool SiliconStudio.BuildEngine.BuildStep.ArePrerequisitesSuccessful

get

Indicate whether all prerequisite commands have been processed and are in a successful state

Definition at line 99 of file BuildStep.cs.

string SiliconStudio.BuildEngine.BuildStep.Description

get

Description of the build step. Intended to be longer and more descriptive than the Title

Definition at line 40 of file BuildStep.cs.

long SiliconStudio.BuildEngine.BuildStep.ExecutionId

getset

An unique id during a build execution, assigned once the build step is scheduled.

Definition at line 89 of file BuildStep.cs.

bool SiliconStudio.BuildEngine.BuildStep.Failed

get

Indicate whether the result corresponds to a failed execution (even if the command has not been triggered)

Definition at line 60 of file BuildStep.cs.

string SiliconStudio.BuildEngine.BuildStep.Module

getset

Gets or sets the module associated with this build step, used when logging error/information.

The module.

Definition at line 22 of file BuildStep.cs.

BuildStep SiliconStudio.BuildEngine.BuildStep.Parent

getset

The parent build step, which will be the instigator of the step

Definition at line 83 of file BuildStep.cs.

IEnumerable<BuildStep> SiliconStudio.BuildEngine.BuildStep.PrerequisiteSteps

get

List of commands that must be executed prior this one (direct dependence only).

Definition at line 71 of file BuildStep.cs.

int SiliconStudio.BuildEngine.BuildStep.Priority

getset

Gets or sets the priority amongst other build steps.

The priority.

Definition at line 30 of file BuildStep.cs.

bool SiliconStudio.BuildEngine.BuildStep.Processed

get

Indicate whether this command has already been processed (ie. executed or skipped) by the Builder

Definition at line 50 of file BuildStep.cs.

IEnumerable<CommandBuildStep> SiliconStudio.BuildEngine.BuildStep.SpawnedSteps

get

List of commands that needs this command to be successfully executed before being processed

Definition at line 77 of file BuildStep.cs.

ResultStatus SiliconStudio.BuildEngine.BuildStep.Status

getset

The status of the result.

Definition at line 45 of file BuildStep.cs.

bool SiliconStudio.BuildEngine.BuildStep.Succeeded

get

Indicate whether the result corresponds to a successful execution (even if the command has not been triggered)

Definition at line 55 of file BuildStep.cs.

object SiliconStudio.BuildEngine.BuildStep.Tag

getset

A tag property that can contain anything useful for tools based on this build Engine.

Definition at line 65 of file BuildStep.cs.

abstract string SiliconStudio.BuildEngine.BuildStep.Title

get

Title of the build step. Intended to be short

Definition at line 35 of file BuildStep.cs.

Event Documentation

EventHandler<BuildStepEventArgs> SiliconStudio.BuildEngine.BuildStep.StepProcessed

Event raised when the command is processed (even if it has been skipped or if it failed)

Definition at line 104 of file BuildStep.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/BuildStep.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation

Event Documentation