VisionSDK.Operations.Operation Class Reference

This class represents any operation made on the VisionDevice
To execute the operation, call the Execute method. More...

Inheritance diagram for VisionSDK.Operations.Operation:

Public Member Functions
	Operation ()
	Constructor More...
object	Clone ()
void	AddCompletionHandler (Action< OperationResult > completionHandler)
	This method sets the completion handler of the operation More...
void	AddCompletionHandler< T > (Action< OperationResult< T >> completionHandler)
	This method sets the completion handler of the operation More...
virtual void	Execute ()
	This method will execute the operation, if possible. This method will check if CanPerformOperation(). If it returns true it will call PerformOperation() More...

Static Public Member Functions
static void	DeleteOperation (Operation operation)
	Delete an Operation and its completion handler More...

Protected Member Functions
virtual bool	CanPerformOperation ()
	An Override to check anything that causes an Operation to fail before its execution. This method should be called before performing the operation so the operation will be executed only if this method returns true More...
virtual void	PerformOperation ()
	Override this method with a new one that contains the operation to execute More...

Protected Attributes
OperationResult	result
	The Operation Result More...

Properties
String	Name [get, set]
	The Operation's Name By Default this is set with the Operation's Type Name More...
OperationResult	Result [get, set]
	The Operation Result More...
Action	CompletionHandler [get, set]
	A delegate associated with the operation This delegate never gets called by this class itself More...

Detailed Description

This class represents any operation made on the VisionDevice
To execute the operation, call the Execute method.

Constructor & Destructor Documentation

VisionSDK.Operations.Operation.Operation

(

)

Constructor

Member Function Documentation

void VisionSDK.Operations.Operation.AddCompletionHandler

(

Action< OperationResult >

completionHandler

)

This method sets the completion handler of the operation

Parameters

completionHandler

The Completion Handler

void VisionSDK.Operations.Operation.AddCompletionHandler< T >

(

Action< OperationResult< T >>

completionHandler

)

This method sets the completion handler of the operation

Template Parameters

T	The Type of the returned value stored inside the OperationResult

Parameters

completionHandler

The Completion Handler

virtual bool VisionSDK.Operations.Operation.CanPerformOperation ( )

protectedvirtual

An Override to check anything that causes an Operation to fail before its execution.
This method should be called before performing the operation so the operation will be executed only if this method returns true

Returns

false if there is any reason to not execute the operation, otherwise true

Reimplemented in VisionSDK.Operations.VisionOperation, VisionSDK.Operations.VisionSetFileOperation< T >, VisionSDK.Operations.VisionGetFileOperation< T >, VisionSDK.Operations.VisionFileOperation, VisionSDK.Operations.VisionGetOperation< T >, VisionSDK.Operations.VisionSetOperation< T >, VisionSDK.Operations.VisionGetPortOperation< T >, VisionSDK.Operations.VisionSetPortOperation< T >, and VisionSDK.Operations.VisionPortOperation.

object VisionSDK.Operations.Operation.Clone

(

)

static void VisionSDK.Operations.Operation.DeleteOperation ( Operation  operation )

static

Delete an Operation and its completion handler

Parameters

operation

The Operation to delete

virtual void VisionSDK.Operations.Operation.Execute ( )

virtual

This method will execute the operation, if possible.
This method will check if CanPerformOperation(). If it returns true it will call PerformOperation()

Reimplemented in VisionSDK.Operations.VisionOperation.

virtual void VisionSDK.Operations.Operation.PerformOperation ( )

protectedvirtual

Override this method with a new one that contains the operation to execute

Member Data Documentation

OperationResult VisionSDK.Operations.Operation.result

protected

The Operation Result

Property Documentation

Action VisionSDK.Operations.Operation.CompletionHandler

getset

A delegate associated with the operation
This delegate never gets called by this class itself

String VisionSDK.Operations.Operation.Name

getset

The Operation's Name
By Default this is set with the Operation's Type Name

OperationResult VisionSDK.Operations.Operation.Result

getset

The Operation Result