com.biocomfort.TO.user_parameters
Class ScaleUserParametersTO

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

public class ScaleUserParametersTO
extends java.lang.Object
implements TO

In order to determine the body fat value, the body water value and the muscle mass value, body diagnostic scales need some additional information about its users. The class ScaleUserParametersTO represents these user parameters data for the body diagnostic scales. Additionally it contains information to configure displayed information of the scales.

See Also:
SDK.setUserParameters(com.biocomfort.TO.MedicalDeviceTO, TO), SDK.setUserParametersAndWait(com.biocomfort.TO.MedicalDeviceTO, TO), SDK.getUserParameters(com.biocomfort.TO.MedicalDeviceTO, TO), SDK.getUserParametersAndWait(com.biocomfort.TO.MedicalDeviceTO, TO), ScaleUserTO, ScaleConfigurationTO

Constructor Summary
ScaleUserParametersTO()
          Constructs a ScaleUserParametersTO object with initializing it so that the user index is set to 1, the scale user parameters reference is set to null, and the scale configuration parameters reference is set to null.
ScaleUserParametersTO(int userIndex)
          Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex.
ScaleUserParametersTO(int userIndex, ScaleUserTO userParameter)
          Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex, and the scale user parameters object by the given parameter scaleUser.
ScaleUserParametersTO(int userIndex, ScaleUserTO scaleUser, ScaleConfigurationTO scaleConfiguration)
          Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex, the scale user parameters object by the given parameter scaleUser, and the scale configuration parameters object by the given parameter scaleConfiguration.
 
Method Summary
 ScaleConfigurationTO getScaleConfiguration()
          Returns a scale configuration object that represents the scale configuration parameters of this ScaleUserParametersTO object.
 ScaleUserTO getScaleUser()
          Returns a scale user object that represents the scale user parameters of this ScaleUserParametersTO object.
 int getUserIndex()
          Returns the user index of this ScaleUserParameters object.
 void setScaleConfiguration(ScaleConfigurationTO scaleConfiguration)
          Sets the scale configuration object that represents the scale configuration parameters of this ScaleUserParametersTO object.
 void setScaleUser(ScaleUserTO scaleUser)
          Sets the scale user object that represents the scale user parameters of this ScaleUserParametersTO object.
 void setUserIndex(int userIndex)
          Sets the user index of this ScaleUserParameters object.
 java.lang.String toString()
          Converts this ScaleUserParametersTO object to a String of the form: ScaleUserParametersTO (userIndex:ui[,g,age:a,height:h,activity:al][,displayMode:dm,units:u]).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScaleUserParametersTO

public ScaleUserParametersTO(int userIndex,
                             ScaleUserTO scaleUser,
                             ScaleConfigurationTO scaleConfiguration)
Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex, the scale user parameters object by the given parameter scaleUser, and the scale configuration parameters object by the given parameter scaleConfiguration.

Parameters:
userIndex - the user index
scaleUser - the scale user parameters
scaleConfiguration - the scale configuration parameters

ScaleUserParametersTO

public ScaleUserParametersTO(int userIndex,
                             ScaleUserTO userParameter)
Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex, and the scale user parameters object by the given parameter scaleUser. The scale configuration parameters reference will be initialized with null.

Parameters:
userIndex - the user index
userParameter - the scale user parameters

ScaleUserParametersTO

public ScaleUserParametersTO(int userIndex)
Constructs a ScaleUserParametersTO object with specifying the user index by the given parameter userIndex. The scale user parameters reference and the scale configuration parameters reference will be initialized with null.

Parameters:
userIndex - the user index

ScaleUserParametersTO

public ScaleUserParametersTO()
Constructs a ScaleUserParametersTO object with initializing it so that the user index is set to 1, the scale user parameters reference is set to null, and the scale configuration parameters reference is set to null.

Method Detail

getUserIndex

public int getUserIndex()
Returns the user index of this ScaleUserParameters object.

Returns:
the user index

setUserIndex

public void setUserIndex(int userIndex)
Sets the user index of this ScaleUserParameters object.

Parameters:
userIndex - the new user index

getScaleUser

public ScaleUserTO getScaleUser()
Returns a scale user object that represents the scale user parameters of this ScaleUserParametersTO object.

Returns:
the scale user parameters

setScaleUser

public void setScaleUser(ScaleUserTO scaleUser)
Sets the scale user object that represents the scale user parameters of this ScaleUserParametersTO object.

Parameters:
scaleUser - the new scale user parameters

getScaleConfiguration

public ScaleConfigurationTO getScaleConfiguration()
Returns a scale configuration object that represents the scale configuration parameters of this ScaleUserParametersTO object.

Returns:
the scale configuration parameters

setScaleConfiguration

public void setScaleConfiguration(ScaleConfigurationTO scaleConfiguration)
Sets the scale configuration object that represents the scale configuration parameters of this ScaleUserParametersTO object.

Parameters:
scaleConfiguration - the new scale configuration parameters

toString

public java.lang.String toString()
Converts this ScaleUserParametersTO object to a String of the form:
 ScaleUserParametersTO (userIndex:ui[,g,age:a,height:h,activity:al][,displayMode:dm,units:u]).
 
where:

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this serial number data object