DVTk API
Session Class
DVTkDvtkApplicationLayerSession
DVTk API

[This is preliminary documentation and is subject to change.]

Summary description for Session.
Declaration Syntax
C#Visual BasicVisual C++
public abstract class Session
Public MustInherit Class Session
public ref class Session abstract
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Session()()()
Constructor

Session(String)
Constructor

ActivityReportEventHandler(Object, ActivityReportEventArgs)
Occurs when a activity report is generated by the application.

AutoCreateDirectory
Determines if a directory is created when this does not yet existing, when writing a Dicom file.

BackUpFiles
Determine the existence of BackUpFiles

BaseLocation
Determines the Base Location Of the Project .

BeginExecute(BaseInput)
Method for executing a session in an Asynchronous manner.

ContinueOnError
Determines of execution should continue when an error has occured.

CreateResultFileName(String)
Method to create result file name.

CreateResults(String)
Method to create result object .

CreateSessionInstance()()()
Method to create the instance of a session.

CreateSessionInstance(String)
Method to create the instance of a session.

DataDirectory
Directory used to store data generated by DVT - DCM files, etc.

Date
Date of test.

DefinitionRootDirectory
Property that represents the Definition directory of a session.

DetailedValidationResults
Determines whether the detailed validation results should be generated while executing.

DetermineDetailName(String)
Method to Determine the detail name of a resultFile.

DetermineSummaryName(String)
Method to Determine the summary name of a resultFile.

DisplayConditionText

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Execute(BaseInput)
Method for executing a session in a synchronous manner.

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetAllProperties()()()
Method to get the Session Properties from a loaded session.

GetBaseNameNoCheck(String)
Method to get the basename for a resultFile.

GetBaseNamesForResultsFiles(ArrayList)
Get the base names from a list of results file names.

GetFileNamesforSession()()()
Get the base names from a list of results file names.

GetHashCode()()()
Serves as a hash function for a particular type. GetHashCode()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetNrSessions()()()
Method to determine the number of sessions in a project.

GetSession(Int32)
Method to get the Session Information from the Collection of sessions with a particular index.

GetSessionChanged(Session)
Method to get the value of bool hasSessionchanged.

GetSessionId(String)
Method to get the sessionId of the session from a resultFile.

GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HasSessionChanged
Property to determine whether the session has been changed

Implementation
Property to access the Dvtk.Sessions.Session

IsExecute
Determine whether the current session is Executing.

isLoaded

LoadSession()()()
Load a session from file.

LogLevelMask
Proerty that set and get the LogLevelFlags for a session.

Manufacturer
Manufacturer for the System Under Test (SUT).

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Mode
If the storage mode is set to as-media, DVT will store a received Image Dataset (Group 0008 up to and including Group 7FE0) in a file with the extension .DCM.

ModelName
Model name for the System Under Test (SUT).

NrOfErrors
Number of Errors.

NrOfWarnings
Number of Warnings.

OptionVerbose
Determine Verbose On/Off

ParentProject
Property that determines the project to which the session belongs.

RemoveSession(Session)
Method to remove a session from a collection of sessions.

Result
Determine the execution of the Session.

Results
Collection of Results for a particular session.

ResultsRootDirectory
Directory used to store results output.

Save()()()
set and save session settings to file with extension .ses.

SaveSession(String)
Save the session.

SaveSessionAs(Session)
Save the session under a new file name. A new session object will be created from this new saved file (and returned by this method) and added to the project. The original session wil not be saved.

SecuritySetting
Property that represents the security setting class for a session.

SessionFileName
File name with extension .ses used during load and save.

SessionId
Identification for the session.

SessionTitle
Title for the session.

SetAllProperties()()()
Method to set the values of Session Properties in a Session.

SetSessionChanged(Session, Boolean)
Method to set the bool hasSessionchanged

SoftwareVersions
Software versions for the System Under Test (SUT).

tempSession

TerminateSession()()()
Method to Terminate the session.

TestedBy
Name of the tester.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Type
Determine the Session Type.

ValidateReferencedFile

Inheritance Hierarchy

Assembly: DvtkApplicationLayer (Module: DvtkApplicationLayer) Version: 0.0.0.0