famValue

famValue( 
o_family 
g_sweepValue
)
=> o_waveformOrFamily

Description

Returns the waveform whose sweepName has the value specified using sweepValue.

Arguments

o_family	A family of waveforms.
o_sweepValue	The value of sweep to retrieve. This must be an exact match with the value specified using famAddValue.

Value Returned

o_waveformOrFamily
	The waveform or family whose sweep value was specified in the argument.

Examples

wave1
srrWave:29298888

wave2
srrWave:29298896

famStr = famCreateFamily( "name" 'string )
=> srrWave:29298920

famAddValue( famStr "one" wave1 )
=> srrWave:29298920

famAddValue( famStr "two" wave2 )
=> srrWave:29298920

famValue( famStr "one")
=> srrWave:29298968
;; although it is a differen waveform it is equivalent.

equal( wave1 famValue( famStr "one" ))
=> t

famValue( famStr "three" )
=> nil

famNum = famCreateFamily( "prf" 'double )
=> srrWave:29299008

famAddValue(famNum 1.0 wave1)
=> srrWave:29299008

famAddValue( famNum 2.0 wave2 )
=> srrWave:29299008

famValue( famNum 1.5 )
=> srrWave:29299056       ;; interpolated waveform is returned

Related Topics

famAddValue

Return to top