OpenTAP 9.27
API Reference
|
Base class for resources. Specializations include Dut, Instrument and ResultListener. More...
Public Member Functions | |
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 | |
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(). | |
Events | |
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. | |
Additional Inherited Members | |
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... | |
Base class for resources. Specializations include Dut, Instrument and ResultListener.
OpenTAP 9.27 API built Wed Nov 27 2024 13:14:46