Keysight Pathwave 89600 VSA .NET API
Recording Class Members
See Also  Properties  Methods  Events
Agilent.SA.Vsa.Interfaces Assembly > Agilent.SA.Vsa Namespace : Recording Class

Glossary Item Box

The following tables list the members exposed by Recording.

Public Properties

 NameDescriptionMinimum SW Version
Public PropertyCurrentFileNameGets the current recording file name.  
Public PropertyIsDisposedGets a value indicating whether the object has been disposed. If an object has been disposed any attempt to use it will lead to an ObjectDisposedException being thrown. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public PropertyIsMultifileRecordingGets a value indicating whether the source for the current recording in VSA is from multiple recording files.  28.00
Public PropertyIsPlayLoopGets or sets a value indicating whether playback of the recording will loop to the starting point when it reaches the stopping point.  
Public PropertyIsPlaySegmentedCaptureGets a value indicating whether the current recording is a segmented capture.  19.00
Public PropertyIsPlayZoomGets a value indicating whether the current recording is zoomed.  
Public PropertyIsRecordLengthExtraGets or sets a value indicating whether extra data will be acquired to be able to settle the measurement filters during playback.  
Public PropertyIsRecordLengthMaximumGets or sets a value indicating whether the recording length will be the maximum supported by the input channels.  
Public PropertyPlayCenterGets the current recording center frequency.  
Public PropertyPlayChannelsGets a handle to a collection of PlayChannel objects  
Public PropertyPlayDelaySecGets the trigger delay (in Sec) of the current recording.  
Public PropertyPlayDeltaSecGets the delta time (in Sec) between sample points in the current recording.  
Public PropertyPlayMaxSpanGets the cardinal frequency span of the current recording.  
Public PropertyPlayPointsGets the number of points in the current recording.  
Public PropertyPlayPointsHugeGets the number of points in the current recording.  23.00
Public PropertyPlayPositionGets or sets the current point of the recording playback.  
Public PropertyPlayPositionHugeGets or sets the current point of the recording playback.  23.00
Public PropertyPlaySampleRateGets the sample rate (in Samples/Sec) of the current recording.  
Public PropertyPlaySegmentCountGets the number of segments in the current recording.  19.00
Public PropertyPlaySegmentTypeGets the current recording segment type in the current file being used for playback. The value returned is only valid if it is a segmented capture recording file.  25.40
Public PropertyPlaySpanGets the frequency span, in Hertz, of the current recording.  
Public PropertyPlayStartGets or sets the starting point of the recording playback.  
Public PropertyPlayStartHugeGets or sets the starting point of the recording playback.  23.00
Public PropertyPlayStartSecGets or sets the starting time of the recording playback.  
Public PropertyPlayStopGets or sets the stopping point of the recording playback.  
Public PropertyPlayStopHugeGets or sets the stopping point of the recording playback.  23.00
Public PropertyPlayStopSecGets or sets the stopping time of the recording playback.  
Public PropertyRecordLengthGets or sets the length of the next recording.  
Public PropertyRecordLengthMaximumTimeGets the maximum recording time supported by the current measurement's input channels.  
Public PropertyRecordLengthTimeGets the time length of the next recording.  
Public PropertyRecordLengthUnitGets or sets the units of the length of the next recording.  
Public PropertySavedFileNameGets the file name that the current recording was last saved to (or recalled from). When recalling multiple files SavedFileName has a semicolon separated list of the recalled files.  
Public PropertyTriggerGets a handle to the ITrigger object for playback.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Methods

 NameDescriptionMinimum SW Version
Public MethodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public MethodForceRebuildKeyMapThis method is used to force a refresh of the key map. This is necessary in cases where the key mappings to the API objects change. This can happen when the index of an item within a collection is reflected in the key name, and an item is removed from the middle of a collection. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public MethodRecallFileOverloaded. Recall the current recording in the specified format from a file.  
Public MethodRecallMultifileRecall multiple recording files in the specified format and pad the recording according to the paddingType, only single channel per file is currently supported with this method.  28.00
Public MethodSaveFileSave all or part of the current recording in the specified format to a file.  
Public MethodSetCenterSpanSet the measurement center/span to match the current recording center/span frequency.  
Public MethodSetRecordLengthSet the length (with its unit) of the next recording.  
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

Public Events

 NameDescriptionMinimum SW Version
Public EventPropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventPropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyChangedOccurs when a property value changes. (Inherited from Agilent.SA.Vsa.RemotableObject)
Public EventRemotePropertyInfoChangedOccurs when secondary information about a property, such as limits, changes. (Inherited from Agilent.SA.Vsa.RemotableObject)14.00
‡ This is the minimum 89600 VSA software version level needed to use this member.
Top

See Also