Package me.clarius.sdk

Enum Class UserFunction

java.lang.Object
java.lang.Enum<UserFunction>
me.clarius.sdk.UserFunction
All Implemented Interfaces:
Serializable, Comparable<UserFunction>, Constable
public enum UserFunction extends Enum<UserFunction>
The possible user functions from a button or listener.

  • Enum Constant Details

    • Freeze

      public static final UserFunction Freeze
      toggle freeze.

    • CaptureImage

      public static final UserFunction CaptureImage
      capture still image.

    • CaptureCine

      public static final UserFunction CaptureCine
      capture cine.

    • DepthDec

      public static final UserFunction DepthDec
      decrease depth.

    • DepthInc

      public static final UserFunction DepthInc
      increase depth.

    • GainDec

      public static final UserFunction GainDec
      decrease gain.

    • GainInc

      public static final UserFunction GainInc
      increase gain.

    • AutoGain

      public static final UserFunction AutoGain
      toggle auto gain.

    • Zoom

      public static final UserFunction Zoom
      toggle zoom.

    • Flip

      public static final UserFunction Flip
      toggle horizontal flip.

    • PlayCine

      public static final UserFunction PlayCine
      play cine when frozen.

    • BMode

      public static final UserFunction BMode
      enter b mode.

    • TMode

      public static final UserFunction TMode
      enter t mode.

    • MMode

      public static final UserFunction MMode
      enter m mode.

    • ColorDoppler

      public static final UserFunction ColorDoppler
      enter color doppler mode.

    • PowerDoppler

      public static final UserFunction PowerDoppler
      enter power doppler mode.

    • PwDoppler

      public static final UserFunction PwDoppler
      enter pulsed wave doppler mode (when available).

    • NeedleEnhance

      public static final UserFunction NeedleEnhance
      enter needle enhance mode (when available).

    • Strain

      public static final UserFunction Strain
      enter strain elastography mode (when available).

    • Ceus

      public static final UserFunction Ceus
      enter contrast enhanced mode (when available).

    • RfMode

      public static final UserFunction RfMode
      enter rf mode (when available).

    • NeedleSide

      public static final UserFunction NeedleSide
      toggle needle enhance side.

    • SetDepth

      public static final UserFunction SetDepth
      set depth in cm.

    • SetGain

      public static final UserFunction SetGain
      set gain in %.

    • CenterGuide

      public static final UserFunction CenterGuide
      toggle center guide.

    • FullScreen

      public static final UserFunction FullScreen
      toggle full screen.

    • VoiceCommand

      public static final UserFunction VoiceCommand
      toggle voice controls.

    • ContrastDec

      public static final UserFunction ContrastDec
      decrease contrast.

    • ContrastInc

      public static final UserFunction ContrastInc
      increase contrast.

    • ColorGainDec

      public static final UserFunction ColorGainDec
      decrease color gain.

    • ColorGainInc

      public static final UserFunction ColorGainInc
      increase color gain.

    • ColorPrfDec

      public static final UserFunction ColorPrfDec
      decrease color prf.

    • ColorPrfInc

      public static final UserFunction ColorPrfInc
      increase color prf.

    • SwitchArray

      public static final UserFunction SwitchArray
      switch array.

    • Split1

      public static final UserFunction Split1
      split screen into 1 display.

    • Split2

      public static final UserFunction Split2
      split screen into 2 displays.

    • Split4

      public static final UserFunction Split4
      split screen into 4 displays.

    • SplitNext

      public static final UserFunction SplitNext
      activate the next display.

    • Annotate

      public static final UserFunction Annotate
      opens annotations.

    • ClearScreen

      public static final UserFunction ClearScreen
      clears screen.

    • PreviousFrame

      public static final UserFunction PreviousFrame
      previous cine frame.

    • NextFrame

      public static final UserFunction NextFrame
      next cine frame.

  • Method Details

    • values

      public static UserFunction[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static UserFunction valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null