Public Types
enum	Mode { Mode.Build, Mode.Clean, Mode.CleanAndDelete }
	Indicate which mode to use with this builder More...

Public Member Functions
	Builder (string buildPath, string buildProfile, string indexFilename, string inputHashesFilename, ILogger logger)

void	CancelBuild ()
	Cancel the currently executing build. More...

void	RunUntilEnd ()

void	Reset ()
	Discard the current Root build step and initialize a new empty one. More...

void	WriteIndexFile (bool mergeWithCurrentIndexFile)
	Write the generated objects into the index map file. More...

BuildResultCode	Run (Mode mode, bool writeIndexFile=true, bool enableMonitor=true)
	Runs this instance. More...

Static Public Member Functions
static void	SetupBuildPath (string buildPath)

Public Attributes
const int	ExpectedVersion = 3

const string	MonitorPipeName = "net.pipe://localhost/Paradox.BuildEngine.Monitor"

readonly ISet< ObjectId >	DisableCompressionIds = new HashSet<ObjectId>()

Static Public Attributes
static readonly string	DoNotPackTag = "DoNotPack"

static readonly string	DoNotCompressTag = "DoNotCompress"

Properties
ILogger	Logger `[get, set]`
	Logger used by the builder and the commands More...

string	BuilderName `[get, set]`
	Builder name More...

Guid	BuilderId `[get, set]`
	The Guid assigned to the builder. More...

string	SlaveBuilderPath `[get, set]`
	The build path for spawned slave processes. More...

int	ThreadCount `[get, set]`
	Number of working threads to create More...

int	MaxParallelProcesses `[get, set]`
	Max number of processes that can be executed for remote commands More...

ListBuildStep	Root `[get, set]`
	The root build step of the builder defining the builds to perform. More...

bool	IsRunning `[get, set]`
	Indicate whether this builder is currently running. More...

bool	Cancelled `[get, set]`
	Indicate whether the build has been canceled More...

List< string >	MonitorPipeNames `[get, set]`

IDictionary< string, string >	InitialVariables `[get, set]`

string	MetadataDatabaseDirectory `[get, set]`

Detailed Description

Definition at line 58 of file Builder.cs.

Member Enumeration Documentation

enum SiliconStudio.BuildEngine.Builder.Mode

Indicate which mode to use with this builder

Enumerator
Build	Build the script
Clean	Clean the command cache used to determine wheither a command has already been triggered.
CleanAndDelete	Clean the command cache and delete every output objects

Definition at line 69 of file Builder.cs.

Constructor & Destructor Documentation

SiliconStudio.BuildEngine.Builder.Builder	(	string	buildPath,
		string	buildProfile,
		string	indexFilename,
		string	inputHashesFilename,
		ILogger	logger
	)

Definition at line 218 of file Builder.cs.

References SiliconStudio.BuildEngine.IndexFileCommand.DatabaseFileProvider.

Member Function Documentation

void SiliconStudio.BuildEngine.Builder.CancelBuild ( )

Cancel the currently executing build.

Definition at line 543 of file Builder.cs.

void SiliconStudio.BuildEngine.Builder.Reset ( )

Discard the current Root build step and initialize a new empty one.

Definition at line 576 of file Builder.cs.

BuildResultCode SiliconStudio.BuildEngine.Builder.Run	(	Mode	mode,
		bool	writeIndexFile = `true`,
		bool	enableMonitor = `true`
	)

Runs this instance.

Definition at line 620 of file Builder.cs.

References SiliconStudio.BuildEngine.QueryMetadataProvider.DefaultDatabaseFilename, SiliconStudio.Core.IO.VirtualFileSystem.FileExists(), and SiliconStudio.Core.Diagnostics.SafeAction.Wrap().

void SiliconStudio.BuildEngine.Builder.RunUntilEnd ( )

Definition at line 552 of file Builder.cs.

static void SiliconStudio.BuildEngine.Builder.SetupBuildPath ( string buildPath )

static

Definition at line 297 of file Builder.cs.

References SiliconStudio.Core.IO.VirtualFileSystem.ApplicationData.

void SiliconStudio.BuildEngine.Builder.WriteIndexFile ( bool mergeWithCurrentIndexFile )

Write the generated objects into the index map file.

Parameters

mergeWithCurrentIndexFile Indicate if old values must be deleted or merged

Definition at line 586 of file Builder.cs.

Member Data Documentation

readonly ISet<ObjectId> SiliconStudio.BuildEngine.Builder.DisableCompressionIds = new HashSet<ObjectId>()

Definition at line 146 of file Builder.cs.

readonly string SiliconStudio.BuildEngine.Builder.DoNotCompressTag = "DoNotCompress"

static

Definition at line 62 of file Builder.cs.

Referenced by SiliconStudio.Assets.Compiler.ImportStreamCommand.ImportStreamCommand().

readonly string SiliconStudio.BuildEngine.Builder.DoNotPackTag = "DoNotPack"

static

Definition at line 61 of file Builder.cs.

const int SiliconStudio.BuildEngine.Builder.ExpectedVersion = 3

Definition at line 60 of file Builder.cs.

const string SiliconStudio.BuildEngine.Builder.MonitorPipeName = "net.pipe://localhost/Paradox.BuildEngine.Monitor"

Definition at line 140 of file Builder.cs.

Property Documentation

Guid SiliconStudio.BuildEngine.Builder.BuilderId

getset

The Guid assigned to the builder.

Definition at line 98 of file Builder.cs.

string SiliconStudio.BuildEngine.Builder.BuilderName

getset

Builder name

Definition at line 93 of file Builder.cs.

bool SiliconStudio.BuildEngine.Builder.Cancelled

getset

Indicate whether the build has been canceled

Definition at line 136 of file Builder.cs.

IDictionary<string, string> SiliconStudio.BuildEngine.Builder.InitialVariables

getset

Definition at line 142 of file Builder.cs.

bool SiliconStudio.BuildEngine.Builder.IsRunning

getset

Indicate whether this builder is currently running.

Definition at line 131 of file Builder.cs.

Referenced by SiliconStudio.BuildEngine.BuildEngineCommands.Cancel().

ILogger SiliconStudio.BuildEngine.Builder.Logger

getset

Logger used by the builder and the commands

Definition at line 88 of file Builder.cs.

int SiliconStudio.BuildEngine.Builder.MaxParallelProcesses

getset

Max number of processes that can be executed for remote commands

Definition at line 117 of file Builder.cs.

string SiliconStudio.BuildEngine.Builder.MetadataDatabaseDirectory

getset

Definition at line 144 of file Builder.cs.

List<string> SiliconStudio.BuildEngine.Builder.MonitorPipeNames

getset

Definition at line 138 of file Builder.cs.

ListBuildStep SiliconStudio.BuildEngine.Builder.Root

getset

The root build step of the builder defining the builds to perform.

Definition at line 126 of file Builder.cs.

string SiliconStudio.BuildEngine.Builder.SlaveBuilderPath

getset

The build path for spawned slave processes.

Definition at line 103 of file Builder.cs.

int SiliconStudio.BuildEngine.Builder.ThreadCount

getset

Number of working threads to create

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation