scoob class
[FTS Data Classes]


Detailed Description

The scoob class.

Score object of various types such as note, rest and trill.


Typedefs

typedef struct scoob scoob_t
 The scoob data type.

Enumerations

enum  scoob_type_enum {
  scoob_note = 0, scoob_interval, scoob_rest, scoob_trill,
  scoob_unvoiced
}
 Scoob types enumeration. More...

Functions

void scoob_set_type (scoob_t *scoob, fts_symbol_t type)
 Set scoob type by symbol.
fts_symbol_t scoob_get_type (scoob_t *scoob)
 Get scoob type as symbol.
void scoob_set_pitch (scoob_t *scoob, double pitch)
 Set scoob pitch.
double scoob_get_pitch (scoob_t *scoob)
 Get scoob pitch.
void scoob_set_interval (scoob_t *scoob, double interval)
 Set scoob interval.
double scoob_get_interval (scoob_t *scoob)
 Get scoob interval.
void scoob_set_duration (scoob_t *scoob, double duration)
 Set scoob duration.
double scoob_get_duration (scoob_t *scoob)
 Get scoob duration.
int scoob_get_type_index (scoob_t *scoob)
 Get index (in scoob_type_enum) of scoob type.
void scoob_set_type_by_index (scoob_t *scoob, int index)
 Set index (in scoob_type_enum) of scoob type.
void scoob_copy (scoob_t *org, scoob_t *copy)
 Copy values from one scoob to another.

Variables

FTS_API fts_class_tscoob_class
 The scoob class identifier (pointer to class instance).
FTS_API fts_schema_tscoob_type_schema
 The scoob default schema.


Enumeration Type Documentation

Scoob types enumeration.

Enumerator:
scoob_note  note type
scoob_interval  interval type
scoob_rest  rest type
scoob_trill  trill type
scoob_unvoiced  unvoiced type


Function Documentation

void scoob_copy ( scoob_t org,
scoob_t copy 
)

Copy values from one scoob to another.

Parameters:
org original scoob
copy copy scoob

double scoob_get_duration ( scoob_t scoob  ) 

Get scoob duration.

Parameters:
scoob the scoob
Returns:
scoob duration

double scoob_get_interval ( scoob_t scoob  ) 

Get scoob interval.

Parameters:
scoob the scoob
Returns:
scoob interval

double scoob_get_pitch ( scoob_t scoob  ) 

Get scoob pitch.

Parameters:
scoob the scoob
Returns:
scoob pitch

fts_symbol_t scoob_get_type ( scoob_t scoob  ) 

Get scoob type as symbol.

Parameters:
scoob the scoob
Returns:
scoob type

int scoob_get_type_index ( scoob_t scoob  ) 

Get index (in scoob_type_enum) of scoob type.

Parameters:
scoob the scoob
Returns:
index in scoob_type_enum

void scoob_set_duration ( scoob_t scoob,
double  duration 
)

Set scoob duration.

Parameters:
scoob the scoob
duration scoob duration

void scoob_set_interval ( scoob_t scoob,
double  interval 
)

Set scoob interval.

Parameters:
scoob the scoob
interval scoob interval

void scoob_set_pitch ( scoob_t scoob,
double  pitch 
)

Set scoob pitch.

Parameters:
scoob the scoob
pitch scoob pitch

void scoob_set_type ( scoob_t scoob,
fts_symbol_t  type 
)

Set scoob type by symbol.

Parameters:
scoob the scoob
type scoob type

void scoob_set_type_by_index ( scoob_t scoob,
int  index 
)

Set index (in scoob_type_enum) of scoob type.

Parameters:
scoob the scoob
index scoob type index in scoob_type_enum


Generated on Wed Aug 24 18:28:43 2011 for FTM API by  doxygen 1.5.6