TASCliSoundPlayDefinition Class Reference

class TASCliSoundPlayDefinition

Defines when alarm sounds are to be played, and for how long.

Alarm sounds are played according to intervals that consist of a duration and an offset.

The duration is the number of seconds that the alarm sound plays.

The offset is the number of minutes after the alarm expires that the alarm sound plays.

The sound play definition is set using class RASCliSession .

Constructor & Destructor Documentation

TASCliSoundPlayDefinition()

TASCliSoundPlayDefinition ( ) [inline]

Default constructor.

The default offset is zero, and the default duration is 30 seconds.

TASCliSoundPlayDefinition(TTimeIntervalMinutes, TTimeIntervalSeconds)

TASCliSoundPlayDefinition ( TTimeIntervalMinutes aOffset,
TTimeIntervalSeconds aDuration
) [inline]

Constructor that initializes the offset and duration to specified values.

Parameters

TTimeIntervalMinutes aOffset Time in minutes for the offset.
TTimeIntervalSeconds aDuration Time in seconds for the duration.

Member Functions Documentation

Duration()

TTimeIntervalSeconds Duration ( ) const [inline]

Retrieves the duration.

Offset()

TTimeIntervalMinutes Offset ( ) const [inline]

Retrieves the offset.

Member Data Documentation

TTimeIntervalSeconds iDuration

TTimeIntervalSeconds iDuration [private]

TTimeIntervalMinutes iOffset

TTimeIntervalMinutes iOffset [private]