Listens to events in the log and outputs them to a file. Can be configured with filters on the log verbosity level. FilePath supports replacement of date and verdict. More...
Inheritance diagram for OpenTap.LogResultListener:
Public Types | |
| enum | FilterOptionsType { Verbose = 1 , Info = 2 , Warnings = 4 , Errors = 8 } |
| FilterOptions for filtering on log message verbosity level. More... | |
Public Member Functions | |
| LogResultListener () | |
| Sets default values. | |
| override void | OnTestPlanRunCompleted (TestPlanRun planRun, Stream logStream) |
| On test plan run completed the previously temporary file is moved to the location expanded by the macro path. | |
 Public Member Functions inherited from OpenTap.ResultListener | |
| virtual void | OnTestPlanRunStart (TestPlanRun planRun) |
| Called when a test plan starts. More... | |
| virtual void | OnTestPlanRunCompleted (TestPlanRun planRun, System.IO.Stream logStream) |
| Called when test plan finishes. At this point no more results will be sent to the result listener from the test plan run. More... | |
| virtual void | OnTestStepRunStart (TestStepRun stepRun) |
| Called just before a test step is started. More... | |
| virtual void | OnTestStepRunCompleted (TestStepRun stepRun) |
| Called when a test step run is completed. Result might still be propagated to the result listener after this event. More... | |
| virtual void | OnResultPublished (Guid stepRunId, ResultTable result) |
| Called when a result is received. More... | |
| Public Member Functions inherited from OpenTap.Resource | |
| Resource () | |
| Instantiate a new instance of Resource class and creates logging source. | |
| override string | ToString () |
| Overrides ToString() to return the Name of the resource. Can be overridden by derived classes to provider a more descriptive name. Note the overrider should include the Name in the output. | |
| virtual void | Open () |
| When overridden in a derived class, should contain implementation to open a connection to the resource represented by this class. Any one time initialization should be done here as well. | |
| virtual void | Close () |
| When overridden in a derived class, should contain implementation to close the connection made to the resource represented by this class. | |
| void | OnActivity () |
| Triggers the ActivityStateChanged event. | |
| Public Member Functions inherited from OpenTap.ValidatingObject | |
| void | OnPropertyChanged (string propertyName) |
| Triggers the PropertyChanged event. More... | |
Properties | |
| MacroString | FilePath [getset] |
| File path of log file. | |
| FilterOptionsType | FilterOptions [getset] |
| Contains the FilterOptions flags. Any combination of the four flags is allowed. | |
| Properties inherited from OpenTap.Resource | |
| TraceSource | Log [get] |
| Default log that the resource object can write to. Typically used by instances and extensions of the Resource object. | |
| string | Name [getset] |
| A short name displayed in the user interface where space is limited. | |
| bool | IsConnected [getset] |
| Indicates whether this resource is currently connected. This value should be set by Open() and Close(). | |
| Properties inherited from OpenTap.ValidatingObject | |
| ValidationRuleCollection | Rules [get] |
| All the validation rules. Add new rules to this in order to get runtime value validation. | |
| string | Error [get] |
| Gets the error messages for each invalid rule and joins them with a newline. | |
| Properties inherited from OpenTap.IValidatingObject | |
| ValidationRuleCollection | Rules [get] |
| A collection of all the currently defined validation rules. Add new rules here in order to get runtime value validation. | |
| 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(). | |
| Properties inherited from OpenTap.IEnabledResource | |
| bool | IsEnabled [getset] |
| Gets or sets if this resources is enabled. | |
| Properties inherited from OpenTap.IFileResultStore | |
| string | FilePath [getset] |
| Gets or sets the currently chosen file. | |
| string | DefaultExtension [get] |
| Default extension without the dot (.) that files must match in order to load a file's results to Results Viewer (e.g. TapResults, not .TapResults). | |
Additional Inherited Members | |
| Protected Member Functions inherited from OpenTap.ResultListener | |
| virtual void | onEnabledChanged (bool oldValue, bool newValue) |
| Called when IsEnabled is changed. More... | |
| Protected Member Functions inherited from OpenTap.ValidatingObject | |
| virtual string | GetError (string propertyName=null) |
| Return the error for a given property | |
| void | ThrowOnValidationError (bool ignoreDisabledProperties) |
| Checks all validation rules on this object (Rules) and throws an AggregateException on errors. More... | |
| Events inherited from OpenTap.Resource | |
| EventHandler< EventArgs > | Activity |
| Invoked on activity. | |
| Events inherited from OpenTap.ValidatingObject | |
| PropertyChangedEventHandler | PropertyChanged |
| Standard PropertyChanged event object. | |
| Events inherited from OpenTap.INotifyActivity | |
| EventHandler< EventArgs > | Activity |
| Invoked on activity. | |
Detailed Description
Listens to events in the log and outputs them to a file. Can be configured with filters on the log verbosity level. FilePath supports replacement of date and verdict.