ajvar.c

Datatypes:
AjPVar Variation data
none Miscellaneous functions


Datatype: AjPVar

Function is for manipulating variation data objects

Sections:
constructorsConstructors
Variation data destructorsDestructors
CastsCasts
variation data modifiersModifiers


AjPVar: constructors

Constructors

Functions:
ajVarNewVar data constructor


Function ajVarNew

Var data constructor

Prototype

AjPVar ajVarNew (
      void
);

TypeNameRead/WriteDescription
AjPVar RETURNNew object

From EMBOSS 6.4.0


AjPVar: Variation data destructors

Destruction destroys all internal data structures and frees the memory allocated for the variation data object.

Functions:
ajVarDelVariation data destructor


Function ajVarDel

Variation data destructor

Prototype

void ajVarDel (
      AjPVar* Pvar
);

TypeNameRead/WriteDescription
AjPVar*PvarDeleteVariation data object to delete
void RETURN

From EMBOSS 6.4.0


AjPVar: Casts

Return values from a variation data object

Functions:
ajVarGetDbReturn the database name
ajVarGetIdReturn the identifier
ajVarGetQryCReturns the query string of a variation data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.
ajVarGetQrySReturns the query string of a variation data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.


Function ajVarGetDb

Return the database name

Prototype

const AjPStr ajVarGetDb (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation
const AjPStr RETURNDatabase name

From EMBOSS 6.4.0


Function ajVarGetId

Return the identifier

Prototype

const AjPStr ajVarGetId (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation
const AjPStr RETURNReturned id

From EMBOSS 6.4.0


Function ajVarGetQryC

Returns the query string of a variation data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Prototype

const char* ajVarGetQryC (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation data object.
const char* RETURNQuery as a character string.

From EMBOSS 6.4.0


Function ajVarGetQryS

Returns the query string of a variation data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Prototype

const AjPStr ajVarGetQryS (
      const AjPVar var
);

TypeNameRead/WriteDescription
const AjPVarvarInputVariation data object.
const AjPStr RETURNQuery as a string.

From EMBOSS 6.4.0


AjPVar: variation data modifiers

Variation data modifiers

Functions:
ajVarClearResets all data for a variation data object so that it can be reused.


Function ajVarClear

Resets all data for a variation data object so that it can be reused.

Prototype

void ajVarClear (
      AjPVar var
);

TypeNameRead/WriteDescription
AjPVarvarModifyVariation data object
void RETURN

From EMBOSS 6.4.0


Datatype: none

Functions to initialise and clean up internals

Sections:
exitMiscellaneous


Section: exit

Functions called on exit from the program by ajExit to do any necessary cleanup and to report internal statistics to the debug file

Functions:
ajVarExitCleans up variation processing internal memory


Function ajVarExit

Cleans up variation processing internal memory

Prototype

void ajVarExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0