Download full document:

Analysis Class

Represents a requested analysis. Use this to monitor the state of the analysis and retrieve the resulting report. An instance of this class is returned from a call to Analyze method of ReportConfiguration class.

Inheritance Hierarchy

System.Object
  Citrix.SDK.AppDNA.Analysis
Namespace: Citrix.SDK.AppDNA
Assembly: Citrix.SDK.AppDNA (in Citrix.SDK.AppDNA.dll) Version: 7.11.0.0 (7.11.0.0)

Syntax

C

public sealed class Analysis : IDisposable

VB

Public NotInheritable Class Analysis
    Implements IDisposable

The Analysis type exposes the following members.

Properties

 

NameDescription
Public propertyApplications Gets an enumeration of the applications that were requested to be analyzed.
Public propertyIsFinished Gets a value indicating whether the analysis has stopped running. Use the ProcessingState property to determine whether the analysis succeeded, failed or was cancelled.
Public propertyPatches Gets an enumeration of the patches that were requested to be analyzed.
Public propertyProcessingState Gets a ProcessingState object that represents the state of the analysis.
Public propertyReportingConfigurations Gets an enumeration of the report configurations that were requested to be used in the analysis.
  Back to Top

Methods

 

NameDescription
Public methodDispose Disposes of the object.
Public methodEquals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodGetReport() Returns an instance of the Report class that contains the results of the analysis. If more than one ReportConfiguration was specified in the analysis, only the report for the first is returned. This must not be called unless IsFinished is true.
Public methodGetReport(ReportConfiguration) Returns an instance of the Report class that contains the results of the analysis. This must not be called unless IsFinished is true.
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Public methodRequestCancel Requests that the analysis stop running. Cancellation may take some time. WaitForCompletion() and ProcessingState can be used to check the state of the analysis.
Public methodToString Returns a string that represents the current object. (Inherited from Object.)
Public methodWaitForCompletion() Returns when IsFinished is true.
Public methodWaitForCompletion(TimeSpan) Waits a specific length of time for completion.
  Back to Top

See Also

Reference

Citrix.SDK.AppDNA Namespace