Inheritance diagram for SiliconStudio.BuildEngine.Command:

Public Member Functions
Task< ResultStatus >	DoCommand (ICommandContext commandContext)
	The method that indirectly call DoCommandOverride to execute the actual command code. It is called by the current Builder when the command is triggered More...

virtual void	PreCommand (ICommandContext commandContext)

virtual void	PostCommand (ICommandContext commandContext, ResultStatus status)

Command	Clone ()

abstract override string	ToString ()

virtual IEnumerable< ObjectUrl >	GetInputFiles ()
	Gets the list of input files (that can be deduced without running the command, only from command parameters). More...

virtual bool	ShouldForceExecution ()
	Check some conditions that determine if the command should be executed. This method may not be called if some previous check determinated that it already needs to be executed. More...

virtual bool	ShouldSpawnNewProcess ()

virtual void	Cancel ()
	Callback called by Builder.CancelBuild. It can be useful for commands in a blocking call that can be unblocked from here. More...

void	ComputeCommandHash (Stream stream, IPrepareContext prepareContext)

Protected Member Functions
abstract Task< ResultStatus >	DoCommandOverride (ICommandContext commandContext)
	The method to override containing the actual command code. It is called by the DoCommand function More...

virtual void	ComputeParameterHash (BinarySerializationWriter writer)

void	ComputeInputFilesHash (BinarySerializationWriter writer, IPrepareContext prepareContext)

virtual void	ComputeAssemblyHash (BinarySerializationWriter writer)

TagSymbol	RegisterTag (string name, Func< string > getValue)

Protected Attributes
const int	CommandCacheVersion = 1
	The command cache version, should be bumped when binary serialization format changes (so that cache gets invalidated) More...

Properties
abstract string	Title `[get]`
	Title (short description) of the command More...

virtual IEnumerable< Tuple < string, string > >	TagList `[get]`
	List every tag created by the command. The first item of each entry is the TagSymbol.Name of the TagSymbol, The second item is the pattern or a description of the TagSymbol.RealName More...

Detailed Description

Definition at line 18 of file Command.cs.

Member Function Documentation

virtual void SiliconStudio.BuildEngine.Command.Cancel ( )

virtual

Callback called by Builder.CancelBuild. It can be useful for commands in a blocking call that can be unblocked from here.

Reimplemented in SiliconStudio.BuildEngine.ExternalProcessCommand.

Definition at line 130 of file Command.cs.

Command SiliconStudio.BuildEngine.Command.Clone ( )

Definition at line 87 of file Command.cs.

Referenced by SiliconStudio.BuildEngine.CommandBuildStep.Clone().

virtual void SiliconStudio.BuildEngine.Command.ComputeAssemblyHash ( BinarySerializationWriter writer )

protectedvirtual

Definition at line 176 of file Command.cs.

void SiliconStudio.BuildEngine.Command.ComputeCommandHash	(	Stream	stream,
		IPrepareContext	prepareContext
	)

Definition at line 160 of file Command.cs.

void SiliconStudio.BuildEngine.Command.ComputeInputFilesHash	(	BinarySerializationWriter	writer,
		IPrepareContext	prepareContext
	)

protected

Definition at line 140 of file Command.cs.

References SiliconStudio.Core.Storage.ObjectId.Empty, and SiliconStudio.Core.Storage.ObjectId.HashSize.

virtual void SiliconStudio.BuildEngine.Command.ComputeParameterHash ( BinarySerializationWriter writer )

protectedvirtual

Reimplemented in SiliconStudio.BuildEngine.ImportModelCommand, SiliconStudio.Assets.Compiler.AssetCommand< T >, SiliconStudio.Assets.CompilerApp.DoNothingCommand, SiliconStudio.Assets.Compiler.FailedCommand, and SiliconStudio.BuildEngine.SingleFileImportCommand.

Definition at line 135 of file Command.cs.

Task<ResultStatus> SiliconStudio.BuildEngine.Command.DoCommand ( ICommandContext commandContext )

The method that indirectly call DoCommandOverride to execute the actual command code. It is called by the current Builder when the command is triggered

Parameters

commandContext

Definition at line 67 of file Command.cs.

abstract Task<ResultStatus> SiliconStudio.BuildEngine.Command.DoCommandOverride ( ICommandContext commandContext )

protectedpure virtual

The method to override containing the actual command code. It is called by the DoCommand function

Parameters

commandContext

Implemented in SiliconStudio.BuildEngine.ImportModelCommand, SiliconStudio.BuildEngine.ImageProcessCommand, SiliconStudio.Assets.Compiler.ImportStreamCommand, SiliconStudio.BuildEngine.ExternalProcessCommand, SiliconStudio.BuildEngine.FileOperationCommand, SiliconStudio.Assets.Compiler.FailedCommand, SiliconStudio.Assets.CompilerApp.DoNothingCommand, SiliconStudio.BuildEngine.DoNothingCommand, SiliconStudio.BuildEngine.ImportStreamCommand, and SiliconStudio.BuildEngine.ImportImageCommand.

virtual IEnumerable<ObjectUrl> SiliconStudio.BuildEngine.Command.GetInputFiles ( )

virtual

Gets the list of input files (that can be deduced without running the command, only from command parameters).

Returns

Reimplemented in SiliconStudio.BuildEngine.ImportModelCommand, SiliconStudio.BuildEngine.FileOperationCommand, SiliconStudio.Assets.Compiler.ImportStreamCommand, SiliconStudio.BuildEngine.ImportImageCommand, SiliconStudio.BuildEngine.ImportStreamCommand, SiliconStudio.BuildEngine.ImageProcessCommand, and SiliconStudio.Assets.Compiler.ThumbnailCommand< T >.

Definition at line 108 of file Command.cs.

virtual void SiliconStudio.BuildEngine.Command.PostCommand	(	ICommandContext	commandContext,
		ResultStatus	status
	)

virtual

Reimplemented in SiliconStudio.BuildEngine.IndexFileCommand.

Definition at line 81 of file Command.cs.

virtual void SiliconStudio.BuildEngine.Command.PreCommand ( ICommandContext commandContext )

virtual

Reimplemented in SiliconStudio.BuildEngine.IndexFileCommand.

Definition at line 75 of file Command.cs.

TagSymbol SiliconStudio.BuildEngine.Command.RegisterTag	(	string	name,
		Func< string >	getValue
	)

protected

Definition at line 185 of file Command.cs.

virtual bool SiliconStudio.BuildEngine.Command.ShouldForceExecution ( )

virtual

Check some conditions that determine if the command should be executed. This method may not be called if some previous check determinated that it already needs to be executed.

Returns: true if the command should be executed

Definition at line 117 of file Command.cs.

virtual bool SiliconStudio.BuildEngine.Command.ShouldSpawnNewProcess ( )

virtual

Reimplemented in SiliconStudio.BuildEngine.ImportFbxCommand.

Definition at line 122 of file Command.cs.

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

pure virtual

Member Data Documentation

const int SiliconStudio.BuildEngine.Command.CommandCacheVersion = 1

protected

The command cache version, should be bumped when binary serialization format changes (so that cache gets invalidated)

Definition at line 23 of file Command.cs.

Property Documentation

virtual IEnumerable<Tuple<string, string> > SiliconStudio.BuildEngine.Command.TagList

get

List every tag created by the command. The first item of each entry is the TagSymbol.Name of the TagSymbol, The second item is the pattern or a description of the TagSymbol.RealName

Definition at line 34 of file Command.cs.

abstract string SiliconStudio.BuildEngine.Command.Title

get

Title (short description) of the command

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

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

Member Data Documentation

Property Documentation