synthclone  0.3.0
synthclone::SamplerJob Class Referenceabstract

Represents a job that will be sent to a Sampler. More...

#include <synthclone/samplerjob.h>

Inheritance diagram for synthclone::SamplerJob:
Collaboration diagram for synthclone::SamplerJob:

Public Types

enum  Type { TYPE_PLAY_DRY_SAMPLE =0, TYPE_PLAY_WET_SAMPLE =1, TYPE_SAMPLE =2 }
 The type of job that will be executed by the Sampler. More...
 

Public Member Functions

virtual Type getType () const =0
 Gets the SamplerJob::Type. More...
 
virtual const ZonegetZone () const =0
 Gets the Zone that the Sampler will use to get information for this SamplerJob. More...
 

Protected Member Functions

 SamplerJob (QObject *parent=0)
 Constructs a new SamplerJob object. More...
 
virtual ~SamplerJob ()
 Destroys a SamplerJob. More...
 

Detailed Description

Represents a job that will be sent to a Sampler.

Member Enumeration Documentation

◆ Type

The type of job that will be executed by the Sampler.

Enumerator
TYPE_PLAY_DRY_SAMPLE 
TYPE_PLAY_WET_SAMPLE 
TYPE_SAMPLE 

Constructor & Destructor Documentation

◆ SamplerJob()

synthclone::SamplerJob::SamplerJob ( QObject *  parent = 0)
explicitprotected

Constructs a new SamplerJob object.

SamplerJob objects cannot be created directly. SamplerJob objects are created by calling Context::addSamplerJob().

Parameters
parentThe parent object of the new SamplerJob.

◆ ~SamplerJob()

virtual synthclone::SamplerJob::~SamplerJob ( )
protectedvirtual

Destroys a SamplerJob.

The application is responsible for managing SamplerJob memory.

Member Function Documentation

◆ getType()

virtual Type synthclone::SamplerJob::getType ( ) const
pure virtual

Gets the SamplerJob::Type.

Returns
The SamplerJob::Type.

◆ getZone()

virtual const Zone* synthclone::SamplerJob::getZone ( ) const
pure virtual

Gets the Zone that the Sampler will use to get information for this SamplerJob.

Returns
The Zone.

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