com.biocomfort.TO.user_parameters
Class ScaleConfigurationTO

java.lang.Object
  extended by com.biocomfort.TO.user_parameters.ScaleConfigurationTO
All Implemented Interfaces:
TO

public class ScaleConfigurationTO
extends java.lang.Object
implements TO

The class ScaleConfigurationTO is a data class to store configuration information for a body diagnostic scale. It is part of the class ScaleUserParametersTO but initially not instantiated in case of using the standard constructor. To store scale configuration information for a ScaleUserParametersTO object create a new instance of this class and assign it to the ScaleUserParametersTO object.


Field Summary
static int DISPLAY_ALL
          Ease-of-use constant to describe the displayed measurement values for body diagnostic scales.
static int DISPLAY_BODYFAT
          Ease-of-use constant to describe the displayed measurement values for body diagnostic scales.
static int DISPLAY_BODYFAT_BODYWATER
          Ease-of-use constant to describe the displayed measurement values for body diagnostic scales.
static int DISPLAY_NONE
          Ease-of-use constant to describe the displayed measurement values for body diagnostic scales.
static int WEIGHT_HEIGHT_UNITS__KG_CM
          Ease-of-use constant to describe the weight and height units displayed by the body diagnostic scale.
static int WEIGHT_HEIGHT_UNITS__LB_FTINCH
          Ease-of-use constant to describe the weight and height units displayed by the body diagnostic scale.
static int WEIGHT_HEIGHT_UNITS__STLB_FTINCH
          Ease-of-use constant to describe the weight and height units displayed by a body diagnostic scale.
 
Constructor Summary
ScaleConfigurationTO()
          Constructs a ScaleConfigurationTO object with initializing it so that the display mode is set to ScaleConfigurationTO.DISPLAY_ALL, the weight and height units configuration is set to ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__KG_CM, and the bits rfMode, bindStatus are set to false.
 
Method Summary
 int getDisplayMode()
          Returns a number that represents the display mode of a body diagnostic scale.
 int getWeightHeightUnits()
          Returns a number that represents the weight and height units configuration of a body diagnostic scale.
 boolean isBindStatusBit()
          Returns true if the flag BIND_STATUS is set.
 boolean isRfModeBit()
          Returns true if the flag RF_MODE is set.
 void setBindStatusBit(boolean bindStatusBit)
          Sets the flag BIND_STATUS.
 void setDisplayMode(int displayMode)
          Sets the display mode of a body diagnostic scale described by a numeric value.
 void setRfModeBit(boolean rfModeBit)
          Sets the flag RF_MODE.
 void setWeightHeightUnits(int weightHeightUnits)
          Sets the weight and height units configuration of a body diagnostic scale described by a numeric value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WEIGHT_HEIGHT_UNITS__KG_CM

public static final int WEIGHT_HEIGHT_UNITS__KG_CM
Ease-of-use constant to describe the weight and height units displayed by the body diagnostic scale. This value will display the user's weight in kg and the user's height in cm.

See Also:
setWeightHeightUnits(int), getWeightHeightUnits(), Constant Field Values

WEIGHT_HEIGHT_UNITS__LB_FTINCH

public static final int WEIGHT_HEIGHT_UNITS__LB_FTINCH
Ease-of-use constant to describe the weight and height units displayed by the body diagnostic scale. This value will display the user's weight in pounds and the user's height in feet/inches.

See Also:
setWeightHeightUnits(int), getWeightHeightUnits(), Constant Field Values

WEIGHT_HEIGHT_UNITS__STLB_FTINCH

public static final int WEIGHT_HEIGHT_UNITS__STLB_FTINCH
Ease-of-use constant to describe the weight and height units displayed by a body diagnostic scale. This value will display the user's weight in stones and the user's height in feet/inches.

See Also:
setWeightHeightUnits(int), getWeightHeightUnits(), Constant Field Values

DISPLAY_ALL

public static final int DISPLAY_ALL
Ease-of-use constant to describe the displayed measurement values for body diagnostic scales. This value will display the body fat, the body water and the muscle mass value additionally to the weight value after a measurement.

See Also:
setDisplayMode(int), getDisplayMode(), Constant Field Values

DISPLAY_BODYFAT_BODYWATER

public static final int DISPLAY_BODYFAT_BODYWATER
Ease-of-use constant to describe the displayed measurement values for body diagnostic scales. This value will only display the body fat and the body water value additionally to the weight value after a measurement.

See Also:
setDisplayMode(int), getDisplayMode(), Constant Field Values

DISPLAY_BODYFAT

public static final int DISPLAY_BODYFAT
Ease-of-use constant to describe the displayed measurement values for body diagnostic scales. This value will only display the body fat value additionally to the weight value after a measurement.

See Also:
setDisplayMode(int), getDisplayMode(), Constant Field Values

DISPLAY_NONE

public static final int DISPLAY_NONE
Ease-of-use constant to describe the displayed measurement values for body diagnostic scales. This value will only display the weight value after a measurement.

See Also:
setDisplayMode(int), getDisplayMode(), Constant Field Values
Constructor Detail

ScaleConfigurationTO

public ScaleConfigurationTO()
Constructs a ScaleConfigurationTO object with initializing it so that the display mode is set to ScaleConfigurationTO.DISPLAY_ALL, the weight and height units configuration is set to ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__KG_CM, and the bits rfMode, bindStatus are set to false.

Method Detail

getWeightHeightUnits

public int getWeightHeightUnits()
Returns a number that represents the weight and height units configuration of a body diagnostic scale. This will be one of the following constants: ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__KG_CM, ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__LB_FTINCH, or ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__STLB_FTINCH.

Returns:
the body diagnostic scale's weight and height units configuration
See Also:
WEIGHT_HEIGHT_UNITS__KG_CM, WEIGHT_HEIGHT_UNITS__LB_FTINCH, WEIGHT_HEIGHT_UNITS__STLB_FTINCH

setWeightHeightUnits

public void setWeightHeightUnits(int weightHeightUnits)
Sets the weight and height units configuration of a body diagnostic scale described by a numeric value. This value must be one of the following constants: ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__KG_CM, ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__LB_FTINCH, or ScaleConfigurationTO.WEIGHT_HEIGHT_UNITS__STLB_FTINCH.

Parameters:
weightHeightUnits - the body diagnostic scale's weight and height units configuration
See Also:
WEIGHT_HEIGHT_UNITS__KG_CM, WEIGHT_HEIGHT_UNITS__LB_FTINCH, WEIGHT_HEIGHT_UNITS__STLB_FTINCH

getDisplayMode

public int getDisplayMode()
Returns a number that represents the display mode of a body diagnostic scale. This will be one of the following constants: ScaleConfigurationTO.DISPLAY_ALL, ScaleConfigurationTO.DISPLAY_BODYFAT_BODYWATER, ScaleConfigurationTO.DISPLAY_BODYFAT, or ScaleConfigurationTO.DISPLAY_NONE.

Returns:
the body diagnostic scale's display mode
See Also:
DISPLAY_ALL, DISPLAY_BODYFAT_BODYWATER, DISPLAY_BODYFAT, DISPLAY_NONE

setDisplayMode

public void setDisplayMode(int displayMode)
Sets the display mode of a body diagnostic scale described by a numeric value. This value must be one of the following constants: ScaleConfigurationTO.DISPLAY_ALL, ScaleConfigurationTO.DISPLAY_BODYFAT_BODYWATER, ScaleConfigurationTO.DISPLAY_BODYFAT, or ScaleConfigurationTO.DISPLAY_NONE.

Parameters:
displayMode - the body diagnostic scale's display mode
See Also:
DISPLAY_ALL, DISPLAY_BODYFAT_BODYWATER, DISPLAY_BODYFAT, DISPLAY_NONE

isRfModeBit

public boolean isRfModeBit()
Returns true if the flag RF_MODE is set.

RF_MODE: Connection with Host is established (Flag is set, when flag ST_RF_ONLINE in 'GlobalStatusWord' was coming)

Returns:
true if the flag RF_MODE is set

setRfModeBit

public void setRfModeBit(boolean rfModeBit)
Sets the flag RF_MODE.

RF_MODE: Connection with Host is established (Flag is set, when flag ST_RF_ONLINE in 'GlobalStatusWord' was coming)

Parameters:
rfModeBit - represents the flag RF_MODE

isBindStatusBit

public boolean isBindStatusBit()
Returns true if the flag BIND_STATUS is set.

BIND_STATUS: Image of flag ST_DEL_BINDING in 'GlobalStatusWord'.

Returns:
true if the flag BIND_STATUS is set

setBindStatusBit

public void setBindStatusBit(boolean bindStatusBit)
Sets the flag BIND_STATUS.

BIND_STATUS: Image of flag ST_DEL_BINDING in 'GlobalStatusWord'.

Parameters:
bindStatusBit - represents the flag BIND_STATUS