COM object EvBeamSubset

EvApplication > EvFileCollection > EvFile > EvVariablesCollection > EvVariableBase As EvVariableVirtual >EvVariableAcousticProperties > EvBeamSubset

View the COM map and the COM summary.

The EvBeamSubset object gives you access to settings on the Beam subset page of the Variable Properties dialog box of the acoustic virtual variable.

EvBeamSubset properties:

Description

Ranges

(read-write) string Ranges

Summary

Access or change the value (expressed as a text string) for the setting Range(s) on the Beam subset page.

Note: Invalid text (which can not be interpreted as a range of beams) will result in an error being logged, and no change being made to the operator.

RangeInclusive

boolean RangeInclusive

Summary

Access or change the setting for Beam Inclusion on the Beam subset page. The default is True and this specifies Include the beam ranges. False specifies Exclude the beam ranges.

Example

Dim VarB: Set VarB = EvFile.Variables.FindByName("Beam subset 1")
   If VarB Is Nothing Then
       MsgBox "Failed to find beam subset variable"
   Else
       Dim VarBeamSubset: Set VarBeamSubset = VarB.AsVariableVirtual
       If VarBeamSubset Is Nothing Then
           MsgBox "Variable is not virtual - beam subset"
       Else
           VarBeamSubset.Properties.BeamSubset.Ranges = "0-5, 10-15"
           MsgBox "Beam subset range changed"
           VarBeamSubset.Properties.BeamSubset.RangeInclusive = False
           MsgBox "Beam subset range inclusive changed to false"
       End If
   End If

COM object EvBeamSubset

Summary

Summary

Example

See also