famGetSweepName

famGetSweepName( 
o_family
[ x_dim ]
)
=> s_sweepName

Description

Returns the name of the sweep variable of the parametric waveform and the dimension supplied.

Arguments

o_family	A family name
x_dim	An integer that specifies how deep the function should go before returning the sweep name.

Value Returned

s_sweepName

The string name of the sweep variable.

Examples

fam1 = famCreateFamily( "prf" 'double )
=> srrWave:29335584

fam2 = famCreateFamily( "prf" 'double )
=> srrWave:29335592

fam3 = famCreateFamily( "ofreq" 'double )
=> srrWave:29335600

famAddValue( fam3 999M fam1)
=> srrWave:29335600

famAddValue( fam3 1G fam2)
=> srrWave:29335600

famGetSweepName( fam3 )
=> "ofreq"

famGetSweepName( fam3 0 )
=> "ofreq"

famGetSweepName( fam3 1 )
=> "prf"

Return to top