AwCore
AnyWave core library
Public Member Functions | Static Public Member Functions | List of all members
AwMarker Class Reference

This class defines the AwMarker object. More...

Public Member Functions

 AwMarker ()
 
 AwMarker (AwMarker *marker)
 
QString & label ()
 
int type ()
 
qint16 value ()
 
float start ()
 
float duration ()
 
float end ()
 
QStringList & targetChannels ()
 

Static Public Member Functions

static int stringToType (const QString &s)
 
static QString typeToString (qint32 t)
 
static QStringList markersTypeList ()
 

Detailed Description

This class defines the AwMarker object.

Markers can mark a specified position in a file or a time selection. They can also target some channels. By default a marker is defined to be global. Addings channels as targets will make it channel specific.

Remarks
Some attributes are optional, like: value, targetedChannels and duration.

Constructor & Destructor Documentation

AwMarker::AwMarker ( )

Default constructor that defines a Single marker.

AwMarker::AwMarker ( AwMarker marker)

Copy constructor.

Member Function Documentation

float AwMarker::duration ( )
inline

Returns the duration in seconds. Single marker has a duration of 0

float AwMarker::end ( )
inline

Returns the ending position of a marker from the beginning of data block.

QString& AwMarker::label ( )
inline

Returns the marker's label.

QStringList AwMarker::markersTypeList ( )
static

Returns a string list of all possible marker types.

float AwMarker::start ( )
inline

Returns the position in seconds from the beginning of data block.

int AwMarker::stringToType ( const QString &  s)
static

Returns an integer value indicating the marker's type based on a string.

stringToType()

QStringList& AwMarker::targetChannels ( )
inline

Returns a string list containing all the channels targeted by the marker. If the list is empty then the marker is not targetting channels but it is a global marker.

int AwMarker::type ( )
inline

Returns the marker's type. AwMarker::Single or AwMarker::Selection.

QString AwMarker::typeToString ( qint32  t)
static

Returns a string indicating the marker's type based on a integer value.

typeToString()

qint16 AwMarker::value ( )
inline

Returns the marker associated valued or -1 if no value is associated to the marker.


The documentation for this class was generated from the following files: