Interface to results storage plugins. More...
Inheritance diagram for OpenTap.IResultStore:
Public Member Functions | |
| 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< IData > | GetEntries (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< LimitSet > | GetLimitSets () |
| 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< AttachmentType > | GetValidAttachments (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
Interface to results storage plugins.
Member Function Documentation
◆ AddLimitSet()
| void OpenTap.IResultStore.AddLimitSet | ( | LimitSet | limitSet | ) |
Adds a limit set to the results store.
- Parameters
-
limitSet
◆ DeleteEntries()
| bool OpenTap.IResultStore.DeleteEntries | ( | IEnumerable< IData > | entries | ) |
Tries to delete the given entries and all sub entries.
- Parameters
-
entries Entries to delete.
◆ DeleteLimitSet()
| void OpenTap.IResultStore.DeleteLimitSet | ( | string | Name | ) |
Deletes a limit set from the database.
- Parameters
-
Name The name of the limit set to delete.
◆ GetAttachment()
| byte[] OpenTap.IResultStore.GetAttachment | ( | IData | entry, |
| AttachmentType | attachmentType | ||
| ) |
Returns the binary data for the given objects attachment, or null if it could not be found.
- Parameters
-
entry attachmentType
◆ GetAverageDuration() [1/2]
| TimeSpan? OpenTap.IResultStore.GetAverageDuration | ( | TestPlanRun | plan, |
| int | averageCount | ||
| ) |
Returns the average duration of the last averageCount PlanRuns runs with a similar plan.
- Parameters
-
plan averageCount
◆ GetAverageDuration() [2/2]
| TimeSpan? OpenTap.IResultStore.GetAverageDuration | ( | TestStepRun | step, |
| int | averageCount | ||
| ) |
Returns the average duration of the last averageCount step runs with similar settings.
- Parameters
-
step averageCount
◆ GetEntries()
| IEnumerable< IData > OpenTap.IResultStore.GetEntries | ( | SearchCondition | cond, |
| List< string > | limitsets, | ||
| bool | withResults | ||
| ) |
Gets all IData elements which match a given search condition.
- Parameters
-
cond limitsets withResults
◆ GetProperties()
| List< string > OpenTap.IResultStore.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.
- Parameters
-
scope Only consider parameters from this scope. Could be "plan" or "step", or empty to consider all scopes. group Only consider parameters from this parameter group. Can be empty to match any group. startsWith limit
◆ GetValidAttachments()
| List< AttachmentType > OpenTap.IResultStore.GetValidAttachments | ( | IData | entry | ) |
Gets a list of attachments on the given object.
- Parameters
-
entry