Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.BuildEngine.CommandBuildStep Class Reference
Inheritance diagram for SiliconStudio.BuildEngine.CommandBuildStep:
SiliconStudio.BuildEngine.BuildStep

Public Member Functions

 CommandBuildStep (Command command)
 
override string ToString ()
 
override BuildStep Clone ()
 Clone this Build Step. More...
 
override 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...
 
override async Task< ResultStatusExecute (IExecuteContext executeContext, BuilderContext builderContext)
 Execute the BuildStep, usually resulting in scheduling tasks in the scheduler More...
 
void AwaitSpawnedCommand (Task< ResultStatus > task)
 
- Public Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
Task< BuildStepExecutedAsync ()
 
IEnumerable< IDictionary
< ObjectUrl, OutputObject > > 
GetOutputObjectsGroups ()
 

Public Attributes

CommandResultEntry Result
 Command Result, set only after step completion. Not thread safe, should not be modified More...
 

Properties

override string Title [get]
 
Command Command [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< BuildStepPrerequisiteSteps [get]
 List of commands that must be executed prior this one (direct dependence only). More...
 
IEnumerable< CommandBuildStepSpawnedSteps [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)
 
- Protected Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
 BuildStep (ResultStatus status=ResultStatus.NotProcessed)
 
- Protected Attributes inherited from SiliconStudio.BuildEngine.BuildStep
readonly List< CommandBuildStepSpawnedStepsList = new List<CommandBuildStep>()
 
- Events inherited from SiliconStudio.BuildEngine.BuildStep
EventHandler< BuildStepEventArgsStepProcessed
 Event raised when the command is processed (even if it has been skipped or if it failed) More...
 

Detailed Description

Definition at line 19 of file CommandBuildStep.cs.

Constructor & Destructor Documentation

SiliconStudio.BuildEngine.CommandBuildStep.CommandBuildStep ( Command  command)

Definition at line 37 of file CommandBuildStep.cs.

Member Function Documentation

void SiliconStudio.BuildEngine.CommandBuildStep.AwaitSpawnedCommand ( Task< ResultStatus task)

Definition at line 428 of file CommandBuildStep.cs.

override void SiliconStudio.BuildEngine.CommandBuildStep.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
executeContextThe execute context
builderContextThe builder context
deleteOutputif true, every output object is also deleted, in addition of the command cache.

Reimplemented from SiliconStudio.BuildEngine.BuildStep.

Definition at line 52 of file CommandBuildStep.cs.

override BuildStep SiliconStudio.BuildEngine.CommandBuildStep.Clone ( )
virtual

Clone this Build Step.

Returns

Implements SiliconStudio.BuildEngine.BuildStep.

Definition at line 47 of file CommandBuildStep.cs.

References SiliconStudio.BuildEngine.Command.Clone().

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

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

Parameters
executeContextThe execute context
builderContextThe builder context
Returns
A task returning ResultStatus indicating weither the execution has successed or failed.

Implements SiliconStudio.BuildEngine.BuildStep.

Definition at line 97 of file CommandBuildStep.cs.

References SiliconStudio.BuildEngine.CommandResultEntry.SpawnedCommands.

override string SiliconStudio.BuildEngine.CommandBuildStep.ToString ( )
virtual

Implements SiliconStudio.BuildEngine.BuildStep.

Definition at line 42 of file CommandBuildStep.cs.

Member Data Documentation

CommandResultEntry SiliconStudio.BuildEngine.CommandBuildStep.Result

Command Result, set only after step completion. Not thread safe, should not be modified

Definition at line 29 of file CommandBuildStep.cs.

Property Documentation

Command SiliconStudio.BuildEngine.CommandBuildStep.Command
getset

Definition at line 24 of file CommandBuildStep.cs.

override string SiliconStudio.BuildEngine.CommandBuildStep.Title
get

Definition at line 22 of file CommandBuildStep.cs.


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