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, foot pedal, or listener.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AutoGain	Toggle auto gain.
BMode	Enter B mode.
CaptureCine	Capture cine.
CaptureImage	Capture still image.
CenterGuide	Toggle center guide.
ColorDoppler	Enter color Doppler mode.
DepthDec	Decrease depth.
DepthInc	Increase depth.
Flip	Toggle horizontal flip.
Freeze	Toggle freeze.
FullScreen	Toggle full screen.
GainDec	Increase gain.
GainInc	Decrease gain.
MMode	Enter M mode.
NeedleEnhance	Enter needle enhance mode (when available).
NeedleSide	Toggle needle enhance side.
PlayCine	Play cine when frozen.
PowerDoppler	Enter power Doppler mode.
PwDoppler	Enter pulsed wave Doppler mode (when available).
RfMode	Enter rf mode (when available).
SetDepth	Set depth in cm.
SetGain	Set gain in %.
Strain	Enter strain elastography mode (when available).
VoiceCommand	Toggle voice commands.
Zoom	Toggle zoom.

Method Summary

Modifier and Type	Method	Description
static UserFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UserFunction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

Increase gain.

GainInc

public static final UserFunction GainInc

Decrease 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.

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).

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 commands.

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