Avaya Conferencing Provider API

com.avaya.conferencing.api.acp.control.operations
Class MeasureSignalToNoiseRatio

java.lang.Object
  extended by com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl<java.lang.Double,MeasureSignalToNoiseRatio>
      extended by com.avaya.conferencing.api.acp.control.operations.MeasureSignalToNoiseRatio
All Implemented Interfaces:
Operation<java.lang.Double,MeasureSignalToNoiseRatio>, java.lang.Cloneable

public class MeasureSignalToNoiseRatio
extends AbstractOperationImpl<java.lang.Double,MeasureSignalToNoiseRatio>

Measures the signal to noise ratio of an EndPoint.

Since:
5.1.1.0.1

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.avaya.conferencing.api.acp.control.operations.Operation
Operation.Impact
 
Method Summary
 Operation.Impact getImpact()
          Returns the impact of the operation.
 long getMeasurementDuration()
          Gets the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
 java.util.concurrent.TimeUnit getMeasurementDurationUnit()
          Gets the units of time used for this operation.
 Verb getVerb()
          This gets the verb that describes this operation.
 void setMeasurementDuration(long measurementDuration)
          Sets the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
 java.lang.String toString()
          
 
Methods inherited from class com.avaya.conferencing.api.acp.control.operations.AbstractOperationImpl
await, await, checkNotSubmitted, checkSubmitted, clone, get, get, isDone, isSubmitted, set
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getMeasurementDuration

public long getMeasurementDuration()
Gets the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.

Returns:
the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
Since:
5.1.1.0.1

setMeasurementDuration

@Required
public void setMeasurementDuration(long measurementDuration)
Sets the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.

Parameters:
measurementDuration - the duration (in getMeasurementDurationUnit()) to sample the signal-to-noise ratio for.
Since:
5.1.1.0.1

getMeasurementDurationUnit

public java.util.concurrent.TimeUnit getMeasurementDurationUnit()
Gets the units of time used for this operation.

Returns:
the units of time used for this operation.
Since:
5.1.1.0.1

toString

public java.lang.String toString()

Overrides:
toString in class AbstractOperationImpl<java.lang.Double,MeasureSignalToNoiseRatio>

getImpact

public Operation.Impact getImpact()
Returns the impact of the operation.

Returns:
the impact.

getVerb

public Verb getVerb()
This gets the verb that describes this operation. Multiple operations may return the same verb, however verbs must be unique across the preferred operations. That is only one prefered operation may implement the "mute" verb. There may be deprecated operations that implement the "mute" verb but these will be less performant as they will be implemented as wrappers for the preferred "mute" operation.

Returns:
the verb that describes the operation.

Avaya Conferencing Provider API

Copyright © 2008-2009 Avaya. All Rights Reserved.