AdventNet WiFi Mediation API, v1.0

com.adventnet.wifi.mediation.beans
Class DataRateSettings

java.lang.Object
  extended bycom.adventnet.wifi.mediation.beans.DataRateSettings

public class DataRateSettings
extends java.lang.Object

Class holding the data rate related parameters of the Access point. This class is primarily used to fetch the data rate related details from the Accesss point or to configure the same.


Field Summary
static int DEFAULT
          Constant representing default data rate setting of the Access point.
static int OPTIMIZE_RANGE
          Constant to indicate that the data rate settings of the Access point has to be optimized for best possible range.
static int OPTIMIZE_THROUGHPUT
          Constant to indicate that the data rate settings of the Access point has to be optimized for best possible throughput.
 
Constructor Summary
DataRateSettings()
           
 
Method Summary
 float[] getBasicDataRate()
          Fetches the basic data rate of the Access point.
 int getDataRateOptimizationFactor()
          Fetches the factor for which the data rate is optimized.
 float[] getEnableDataRate()
          Fetches the data rates that are enabled.
 void optimizeDataRate(int optimizationFactor)
          Sets the factor based on which the data rate should be optimized.
 void setBasicDataRate(float[] dataRate)
          Sets the basic data rate of the Access point.
 void setEnableDataRate(float[] dataRate)
          Enables the specified data rates in the Access point.
 java.lang.String toString()
          Returns the String representation of this bean.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPTIMIZE_RANGE

public static final int OPTIMIZE_RANGE
Constant to indicate that the data rate settings of the Access point has to be optimized for best possible range.

See Also:
Constant Field Values

DEFAULT

public static final int DEFAULT
Constant representing default data rate setting of the Access point.

See Also:
Constant Field Values

OPTIMIZE_THROUGHPUT

public static final int OPTIMIZE_THROUGHPUT
Constant to indicate that the data rate settings of the Access point has to be optimized for best possible throughput.

See Also:
Constant Field Values
Constructor Detail

DataRateSettings

public DataRateSettings()
Method Detail

setBasicDataRate

public void setBasicDataRate(float[] dataRate)
Sets the basic data rate of the Access point.

Parameters:
dataRate - the array of data rates.
See Also:
MediationConstants.DATARATE_80211A, MediationConstants.DATARATE_80211BG

getBasicDataRate

public float[] getBasicDataRate()
Fetches the basic data rate of the Access point.

Returns:
the basic data rates of the Access point in a array.
See Also:
MediationConstants.DATARATE_80211A, MediationConstants.DATARATE_80211BG

setEnableDataRate

public void setEnableDataRate(float[] dataRate)
Enables the specified data rates in the Access point.

Parameters:
dataRate - the array of data rates.
See Also:
MediationConstants.DATARATE_80211A, MediationConstants.DATARATE_80211BG

getEnableDataRate

public float[] getEnableDataRate()
Fetches the data rates that are enabled.

Returns:
the array of data rates that are enabled.
See Also:
MediationConstants.DATARATE_80211A, MediationConstants.DATARATE_80211BG

optimizeDataRate

public void optimizeDataRate(int optimizationFactor)
Sets the factor based on which the data rate should be optimized. That is whether it should be optimized for range, or throughput etc.,

Parameters:
optimizationFactor - the factor for which the data rate should be optimized.
See Also:
OPTIMIZE_RANGE, DEFAULT, OPTIMIZE_THROUGHPUT

getDataRateOptimizationFactor

public int getDataRateOptimizationFactor()
Fetches the factor for which the data rate is optimized. That is whether it is optimized for range, or throughput etc.,

Returns:
the optimizationFactor
See Also:
OPTIMIZE_RANGE, DEFAULT, OPTIMIZE_THROUGHPUT

toString

public java.lang.String toString()
Returns the String representation of this bean.

Returns:
String representation of this bean

AdventNet WiFi Mediation API, v1.0

Copyright © 2005 AdventNet Inc. All Rights Reserved.