SiliconStudio.BuildEngine.FileOperationCommand Class Reference

Inheritance diagram for SiliconStudio.BuildEngine.FileOperationCommand:

Public Types
enum	Operation { Operation.Move, Operation.Copy, Operation.Delete }

Public Member Functions
override IEnumerable< ObjectUrl >	GetInputFiles ()
	Gets the list of input files (that can be deduced without running the command, only from command parameters). More...
override string	ToString ()
Public Member Functions inherited from SiliconStudio.BuildEngine.Command
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 ()
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
override async Task< ResultStatus >	DoCommandOverride (ICommandContext commandContext)
	The method to override containing the actual command code. It is called by the DoCommand function More...
override void	ComputeParameterHash (Stream stream)
Protected Member Functions inherited from SiliconStudio.BuildEngine.Command
virtual void	ComputeParameterHash (BinarySerializationWriter writer)
void	ComputeInputFilesHash (BinarySerializationWriter writer, IPrepareContext prepareContext)
virtual void	ComputeAssemblyHash (BinarySerializationWriter writer)
TagSymbol	RegisterTag (string name, Func< string > getValue)

Properties
override string	Title [get]
string	Source [get, set]
string	Target [get, set]
bool	Overwrite [get, set]
Operation	Type [get, set]
Properties inherited from SiliconStudio.BuildEngine.Command
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...

Additional Inherited Members
Protected Attributes inherited from SiliconStudio.BuildEngine.Command
const int	CommandCacheVersion = 1
	The command cache version, should be bumped when binary serialization format changes (so that cache gets invalidated) More...

Detailed Description

Definition at line 14 of file FileOperationCommand.cs.

Member Enumeration Documentation

enum SiliconStudio.BuildEngine.FileOperationCommand.Operation

Enumerator
Move
Copy
Delete

Definition at line 19 of file FileOperationCommand.cs.

Member Function Documentation

override void SiliconStudio.BuildEngine.FileOperationCommand.ComputeParameterHash ( Stream  stream )

protected

Definition at line 69 of file FileOperationCommand.cs.

override async Task<ResultStatus> SiliconStudio.BuildEngine.FileOperationCommand.DoCommandOverride ( ICommandContext  commandContext )

protectedvirtual

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

Parameters

commandContext

Implements SiliconStudio.BuildEngine.Command.

Definition at line 31 of file FileOperationCommand.cs.

override IEnumerable<ObjectUrl> SiliconStudio.BuildEngine.FileOperationCommand.GetInputFiles ( )

virtual

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

Returns

Reimplemented from SiliconStudio.BuildEngine.Command.

Definition at line 64 of file FileOperationCommand.cs.

override string SiliconStudio.BuildEngine.FileOperationCommand.ToString ( )

virtual

Implements SiliconStudio.BuildEngine.Command.

Definition at line 79 of file FileOperationCommand.cs.

Property Documentation

bool SiliconStudio.BuildEngine.FileOperationCommand.Overwrite

getset

Definition at line 28 of file FileOperationCommand.cs.

string SiliconStudio.BuildEngine.FileOperationCommand.Source

getset

Definition at line 26 of file FileOperationCommand.cs.

string SiliconStudio.BuildEngine.FileOperationCommand.Target

getset

Definition at line 27 of file FileOperationCommand.cs.

override string SiliconStudio.BuildEngine.FileOperationCommand.Title

get

Definition at line 17 of file FileOperationCommand.cs.

Operation SiliconStudio.BuildEngine.FileOperationCommand.Type

getset

Definition at line 29 of file FileOperationCommand.cs.

---

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

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.BuildEngine.Paradox.BaseCommands/FileOperationCommand.cs