DVTk API
ScriptSession Class
DVTkDvtkApplicationLayerScriptSession
DVTk API

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

Summary description for ScriptSession.
Declaration Syntax
C#Visual BasicVisual C++
public class ScriptSession : Session
Public Class ScriptSession _
	Inherits Session
public ref class ScriptSession : public Session
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
ScriptSession()()()
Constructor for ScriptSession.

ScriptSession(String)
Constructor for ScriptSession.

AddGroupLength
The AddGroupLength option, is used to have DVT add Group Length attributes to all Groups found in each message sent.

AutoCreateDirectory
Determines if a directory is created when this does not yet existing, when writing a Dicom file.
(Inherited from Session.)
BackUpFiles
Determine the existence of BackUpFiles
(Inherited from Session.)
BaseLocation
Determines the Base Location Of the Project .
(Inherited from Session.)
BeginExecute(BaseInput)
Method for executing a session in an Asynchronous manner.
(Overrides Session.BeginExecute(BaseInput).)
ContinueOnError
Determines of execution should continue when an error has occured.
(Inherited from Session.)
CreateResultFileName(String)
Method to create result file name.
(Inherited from Session.)
CreateResults(String)
Method to create result object .
(Inherited from Session.)
CreateScriptFiles()()()
Method to create result for a script and set its properties.

CreateSessionInstance()()()
Method to create the instance of a EmulatorSession.
(Overrides Session.CreateSessionInstance()()().)
CreateSessionInstance(String)
Method to create the instance of a session.
(Overrides Session.CreateSessionInstance(String).)
DataDirectory
Directory used to store data generated by DVT - DCM files, etc.
(Inherited from Session.)
Date
Date of test.
(Inherited from Session.)
DefineSqLength
The DefineSqLength option, is used to make DVT encode explicit length Sequences when sending messages.

DefinitionRootDirectory
Property that represents the Definition directory of a session.
(Inherited from Session.)
DescriptionDirectory
The directory containing instructive and explanatory description files for the scripts.

DetailedValidationResults
Determines whether the detailed validation results should be generated while executing.
(Inherited from Session.)
DetermineDetailName(String)
Method to Determine the detail name of a resultFile.
(Inherited from Session.)
DetermineSummaryName(String)
Method to Determine the summary name of a resultFile.
(Inherited from Session.)
DicomScriptRootDirectory
Represents root directory of the scripts in a session.

DisplayConditionText
(Inherited from Session.)
DvtAeTitle
The DVT AE Title is the application entity name of the DVT machine in the test.

DvtImplementationClassUid
This is the unique identifier (UID) for the Dicom Validation Tool (DVT) implementation.

DvtImplementationVersionName
This is the implementation version name for the Dicom Validation Tool (DVT) implementation.

DvtMaximumLengthReceived
The maximum length of message fragment (P-DATA-TF PDU) that the Dicom Validation Tool (DVT) can receive from the System Under Test (SUT).

DvtPort
The port that the Dicom Validation Tool (DVT) should use when making a connection to System Under Test (SUT).

DvtSocketTimeout
The period that the Dicom Validation Tool (DVT) will listen for incomming messages on the TCP/IP connection before automatically aborting the session.

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.
(Overrides Session.Execute(BaseInput).)
ExecuteVisualBasicScript()()()
Execute the Visual Basic Script.

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.
(Overrides Session.GetAllProperties()()().)
GetBaseNameNoCheck(String)
Method to get the basename for a resultFile.
(Inherited from Session.)
GetBaseNamesForResultsFiles(ArrayList)
Get the base names from a list of results file names.
(Inherited from Session.)
GetFileNamesforSession()()()
Get the base names from a list of results file names.
(Inherited from Session.)
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.
(Inherited from Session.)
GetSession(Int32)
Method to get the Session Information from the Collection of sessions with a particular index.
(Inherited from Session.)
GetSessionChanged(Session)
Method to get the value of bool hasSessionchanged.
(Inherited from Session.)
GetSessionId(String)
Method to get the sessionId of the session from a resultFile.
(Inherited from Session.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
HasSessionChanged
Property to determine whether the session has been changed
(Inherited from Session.)
Implementation
Property to access the Dvtk.Sessions.Session
(Inherited from Session.)
IsExecute
Determine whether the current session is Executing.
(Inherited from Session.)
isLoaded
(Inherited from Session.)
LoadSession()()()
Load a session from file.
(Inherited from Session.)
LogLevelMask
Proerty that set and get the LogLevelFlags for a session.
(Inherited from Session.)
Manufacturer
Manufacturer for the System Under Test (SUT).
(Inherited from Session.)
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.
(Inherited from Session.)
ModelName
Model name for the System Under Test (SUT).
(Inherited from Session.)
NrOfErrors
Number of Errors.
(Inherited from Session.)
NrOfWarnings
Number of Warnings.
(Inherited from Session.)
OptionVerbose
Determine Verbose On/Off
(Inherited from Session.)
ParentProject
Property that determines the project to which the session belongs.
(Inherited from Session.)
RemoveSession(Session)
Method to remove a session from a collection of sessions.
(Inherited from Session.)
Result
Determine the execution of the Session.
(Inherited from Session.)
Results
Collection of Results for a particular session.
(Inherited from Session.)
ResultsRootDirectory
Directory used to store results output.
(Inherited from Session.)
Save()()()
set and save ScriptSession settings to file with extension .ses.
(Overrides Session.Save()()().)
SaveSession(String)
Save the session.
(Inherited from 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.
(Inherited from Session.)
ScriptFiles
Representa a Collection of scripts in a session.

ScriptSessionImplementation
Property to access the Dvtk.Session.ScriptSession

SecureSocketsEnabled
Enable or disable secure socket communication

SecuritySetting
Property that represents the security setting class for a session.
(Inherited from Session.)
SessionFileName
File name with extension .ses used during load and save.
(Inherited from Session.)
SessionId
Identification for the session.
(Inherited from Session.)
SessionTitle
Title for the session.
(Inherited from Session.)
SetAllProperties()()()
Method to set the values of Session Properties in a SessionFile.
(Overrides Session.SetAllProperties()()().)
SetSessionChanged(Session, Boolean)
Method to set the bool hasSessionchanged
(Inherited from Session.)
SoftwareVersions
Software versions for the System Under Test (SUT).
(Inherited from Session.)
SutAeTitle
The AE Title is the application entity name of the SUT machine in the test.

SutHostName
The name that the Dicom Validation Tool (DVT) should use when making a connection to the product machine of the System Under Test (SUT).

SutImplementationClassUid
This is the unique identifier (UID) for the Product's implementation of the System Under Test (SUT).

SutImplementationVersionName
The version name given by the Manufacturer to the Product implementation to identify it internally. DVT checks that the value sent by the Product matches the values given here.

SutMaximumLengthReceived
The maximum length of message fragment (P-DATA-TF PDU) that the System Under Test (SUT) can receive from the Dicom Validation Tool (DVT).

SutPort
The port number that the Dicom Validation Tool (DVT) should use when making a connection to the product machine of the System Under Test (SUT).

tempSession
(Inherited from Session.)
TestedBy
Name of the tester.
(Inherited from Session.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Type
Determine the Session Type.
(Inherited from Session.)
ValidateReferencedFile
(Inherited from Session.)
Inheritance Hierarchy
Object
Session
 ScriptSession

Assembly: DvtkApplicationLayer (Module: DvtkApplicationLayer) Version: 0.0.0.0