OpenTAP 9.25
API Reference
Public Member Functions | List of all members
OpenTap.IAttachmentStream Interface Reference

IResultStore that supports attachment streams. More...

Inheritance diagram for OpenTap.IAttachmentStream:
OpenTap.IResultStore OpenTap.IResource OpenTap.ITapPlugin

Public Member Functions

Stream GetAttachmentStream (IData entry, AttachmentType attachmentType)
 Returns a stream that can read a given attachment entry. The returned stream must be disposed. More...
 
- Public Member Functions inherited from OpenTap.IResultStore
List< string > GetProperties (string scope, string group, string startsWith, int limit)
 Get list of properties on entries in the database which starts with a given string. The returned properties should be ordered by their frequency of use in the dataset. More...
 
IEnumerable< IDataGetEntries (SearchCondition cond, List< string > limitsets, bool withResults)
 Gets all IData elements which match a given search condition. More...
 
bool DeleteEntries (IEnumerable< IData > entries)
 Tries to delete the given entries and all sub entries. More...
 
List< LimitSetGetLimitSets ()
 Returns all registered limit sets.
 
void AddLimitSet (LimitSet limitSet)
 Adds a limit set to the results store. More...
 
void DeleteLimitSet (string Name)
 Deletes a limit set from the database. More...
 
byte[] GetAttachment (IData entry, AttachmentType attachmentType)
 Returns the binary data for the given objects attachment, or null if it could not be found. More...
 
List< AttachmentTypeGetValidAttachments (IData entry)
 Gets a list of attachments on the given object. More...
 
TimeSpan? GetAverageDuration (TestStepRun step, int averageCount)
 Returns the average duration of the last averageCount step runs with similar settings. More...
 
TimeSpan? GetAverageDuration (TestPlanRun plan, int averageCount)
 Returns the average duration of the last averageCount PlanRuns runs with a similar plan. More...
 
- Public Member Functions inherited from OpenTap.IResource
void Open ()
 When overridden in a derived class, opens a connection to the resource represented by this class.
 
void Close ()
 When overridden in a derived class, closes the connection made to the resource represented by this class.
 

Additional Inherited Members

- Properties inherited from OpenTap.IResource
string Name [getset]
 A short name to display in the user interface in areas with limited space.
 
bool IsConnected [get]
 Indicates whether this DUT is currently connected. This value should be set by Open() and Close().
 

Detailed Description

IResultStore that supports attachment streams.

Member Function Documentation

◆ GetAttachmentStream()

Stream OpenTap.IAttachmentStream.GetAttachmentStream ( IData  entry,
AttachmentType  attachmentType 
)

Returns a stream that can read a given attachment entry. The returned stream must be disposed.

Parameters
entry
attachmentType

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:23