common.h File Reference

Defines constants, types and helper functions that are used throughout the library but are not visible externally. More...

#include "fret.h"

Include dependency graph for common.h:

This graph shows which files directly or indirectly include this file:

Enumerations
enum	{ NON_BUFFER_ID = 0, MIN_BUFFER_ID = 1 }
Functions
void	resetGram (Gram *const pGram)
void	setError (FretError error)
FretError	getError (void)
void	setMinLength (unsigned int len)
unsigned int	getMinLength (void)

---

Detailed Description

Defines constants, types and helper functions that are used throughout the library but are not visible externally.

---

Enumeration Type Documentation

anonymous enum

Constants used within the library. Enumerator: NON_BUFFER_ID  An invalid Buffer ID. MIN_BUFFER_ID  Minimum possible Buffer ID.

---

Function Documentation

FretError getError (  void   )

Return the internal error code.

unsigned int getMinLength (  void   )

Get the minimum Gram length.

void resetGram (  Gram *const   pGram  )

Initialise fields in a Gram structure.

void setError (  FretError  error  )

Save an internal error code.

void setMinLength (  unsigned int  len  )

Set the minimum Gram length.

---