Package de.gmxhome.conrad.jpos.jpos_base.toneindicator

Interface ToneIndicatorInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

ToneIndicator, ToneIndicatorProperties

public interface ToneIndicatorInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the ToneIndicator device category. For details about properties, methods and method parameters, see UPOS specification, chapter Tone Indicator. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	interToneWait(int delay)	Final part of setting InterToneWait.
void	melodyType(int type)	Final part of setting MelodyType.
void	melodyVolume(int volume)	Final part of setting MelodyVolume.
Sound	sound(int numberOfCycles, int interSoundWait)	Validation part of Sound method.
void	sound(Sound request)	Final part of Sound method.
void	tone1Duration(int duration)	Final part of setting Tone1Duration.
void	tone1Pitch(int type)	Final part of setting Tone1Pitch.
void	tone1Volume(int type)	Final part of setting Tone1Volume.
void	tone2Duration(int type)	Final part of setting Tone2Duration.
void	tone2Pitch(int type)	Final part of setting Tone2Pitch.
void	tone2Volume(int type)	Final part of setting Tone2Volume.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

melodyType

void melodyType(int type)
         throws jpos.JposException

Final part of setting MelodyType. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• type is between 0 and CapMelody.

Parameters:

type - New MelodyType value

Throws:

jpos.JposException - If an error occurs during enable or disable

melodyVolume

void melodyVolume(int volume)
           throws jpos.JposException

Final part of setting MelodyVolume. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

volume - New MelodyVolume value

Throws:

jpos.JposException - If an error occurs during enable or disable

interToneWait

void interToneWait(int delay)
            throws jpos.JposException

Final part of setting InterToneWait. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• delay is ≥ 0.

Parameters:

delay - New InterToneWait value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone1Duration

void tone1Duration(int duration)
            throws jpos.JposException

Final part of setting Tone1Duration. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

duration - New Tone1Duration value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone1Pitch

void tone1Pitch(int type)
         throws jpos.JposException

Final part of setting Tone1Pitch. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

type - New Tone1Pitch value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone1Volume

void tone1Volume(int type)
          throws jpos.JposException

Final part of setting Tone1Volume. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

type - New Tone1Volume value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone2Duration

void tone2Duration(int type)
            throws jpos.JposException

Final part of setting Tone2Duration. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

type - New Tone2Duration value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone2Pitch

void tone2Pitch(int type)
         throws jpos.JposException

Final part of setting Tone2Pitch. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

type - New Tone2Pitch value

Throws:

jpos.JposException - If an error occurs during enable or disable

tone2Volume

void tone2Volume(int type)
          throws jpos.JposException

Final part of setting Tone2Volume. Can be overwritten within derived classes, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled.

Parameters:

type - New Tone2Volume value

Throws:

jpos.JposException - If an error occurs during enable or disable

sound

Sound sound(int numberOfCycles,
 int interSoundWait)
     throws jpos.JposException

Validation part of Sound method. For details, see UPOS specification. Can be overwritten within derived classes, if necessary. This method shall only perform additional validation. It will be called before the service buffers the method call for synchronous or asynchronous execution. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• interSoundWait ≥ 0,
• numberOfCycles > 0 or JPOS_FOREVER,
• AsyncMode is false: numberOfCycles is not JPOS_FOREVER.

This method will be used in method SoundImmediate as well.

Parameters:

numberOfCycles - The number of cycles to sound the indicator device. If FOREVER, then start the indicator sounding and repeat continuously, else perform the sound for the specified number of cycles.

interSoundWait - When numberOfCycles is not one, then pause for interSoundWait milliseconds before repeating the tone cycle (before playing tone-1 again).

Returns:

Sound object for use in final part.

Throws:

jpos.JposException - For details, see UPOS method Sound.

sound

void sound(Sound request)
    throws jpos.JposException

Final part of Sound method. Can be overwritten within derived classes, if necessary. The parameters of the method will be passed via a Sound object. This method will be called when the corresponding operation shall be performed, either synchronously or asynchronously. All plausibility checks have been made before, only runtime errors can occur.
This method will be used in method SoundImmediate as well.

Parameters:

request - Sound object. Used to perform methods synchronously or asynchronously, depending on call parameters. Holds Abort and EndSync objects that should be checked in longer operations.

Throws:

jpos.JposException - See UPOS specification, method Sound