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

Public Member Functions

 DynamicBuildStep (IBuildStepProvider buildStepProvider)
 
void NotifyNewWorkAvailable ()
 Notify the dynamic build step new work is available. More...
 
async override Task< ResultStatusExecute (IExecuteContext executeContext, BuilderContext builderContext)
 Execute the BuildStep, usually resulting in scheduling tasks in the scheduler More...
 
override BuildStep Clone ()
 Clone this Build Step.
Returns
More...
 
override string ToString ()
 
- Public Member Functions inherited from SiliconStudio.BuildEngine.EnumerableBuildStep
override async Task< ResultStatusExecute (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...
 
Task< BuildStepExecutedAsync ()
 
IEnumerable< IDictionary
< ObjectUrl, OutputObject > > 
GetOutputObjectsGroups ()
 

Additional Inherited Members

- Static Public Member Functions inherited from SiliconStudio.BuildEngine.BuildStep
static void LinkBuildSteps (BuildStep parent, BuildStep child)
 
- Public Attributes inherited from SiliconStudio.BuildEngine.EnumerableBuildStep
readonly IEnumerable< ObjectUrlInputUrls
 
- Protected Member Functions inherited from SiliconStudio.BuildEngine.EnumerableBuildStep
 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 inherited from SiliconStudio.BuildEngine.EnumerableBuildStep
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< CommandBuildStepSpawnedStepsList = new List<CommandBuildStep>()
 
- Properties inherited from SiliconStudio.BuildEngine.EnumerableBuildStep
override string Title [get]
 
IDictionary< ObjectUrl,
OutputObject
OutputObjects [get]
 
IEnumerable< BuildStepSteps [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...
 
- 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 10 of file DynamicBuildStep.cs.

Constructor & Destructor Documentation

SiliconStudio.BuildEngine.DynamicBuildStep.DynamicBuildStep ( IBuildStepProvider  buildStepProvider)

Definition at line 22 of file DynamicBuildStep.cs.

Member Function Documentation

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

Clone this Build Step.

Returns

Implements SiliconStudio.BuildEngine.BuildStep.

Definition at line 80 of file DynamicBuildStep.cs.

async override Task<ResultStatus> SiliconStudio.BuildEngine.DynamicBuildStep.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 35 of file DynamicBuildStep.cs.

References SiliconStudio.BuildEngine.IExecuteContext.CancellationTokenSource.

void SiliconStudio.BuildEngine.DynamicBuildStep.NotifyNewWorkAvailable ( )

Notify the dynamic build step new work is available.

Definition at line 30 of file DynamicBuildStep.cs.

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

Implements SiliconStudio.BuildEngine.BuildStep.

Definition at line 87 of file DynamicBuildStep.cs.


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