ajvar.c

Datatypes:
AjPVar Variation data
AjPVarData Variation data records
AjPVarField Variation field
AjPVarHeader Variation header
AjPVarSample Variation sample
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:
ajVarNewVariation data constructor


Function ajVarNew

Variation 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.
ajVarResetResets 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


Function ajVarReset

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

Prototype

void ajVarReset (
      AjPVar var
);

TypeNameRead/WriteDescription
AjPVarvarModifyVariation data object
void RETURN

From EMBOSS 6.5.0


Datatype: AjPVarData

Function is for manipulating variation data record objects

Sections:
constructorsConstructors
Variation data record destructorsDestructors
variation data record modifiersModifiers


AjPVarData: constructors

Constructors

Functions:
ajVardataNewVariation data record constructor


Function ajVardataNew

Variation data record constructor

Prototype

AjPVarData ajVardataNew (
      void
);

TypeNameRead/WriteDescription
AjPVarData RETURNNew object

From EMBOSS 6.5.0


AjPVarData: Variation data record destructors

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

Functions:
ajVardataDelVariation data record destructor


Function ajVardataDel

Variation data record destructor

Prototype

void ajVardataDel (
      AjPVarData* Pvar
);

TypeNameRead/WriteDescription
AjPVarData*PvarDeleteVariation data record object to delete
void RETURN

From EMBOSS 6.5.0


AjPVarData: variation data record modifiers

Variation data record modifiers

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


Function ajVardataClear

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

Prototype

void ajVardataClear (
      AjPVarData var
);

TypeNameRead/WriteDescription
AjPVarDatavarModifyVariation data record object
void RETURN

From EMBOSS 6.5.0


Datatype: AjPVarField

Function is for manipulating variation field objects

Sections:
constructorsConstructors
Variation field destructorsDestructors
variation field modifiersModifiers
variation field castsCasts


AjPVarField: constructors

Constructors

Functions:
ajVarfieldNewVariation data constructor


Function ajVarfieldNew

Variation data constructor

Prototype

AjPVarField ajVarfieldNew (
      void
);

TypeNameRead/WriteDescription
AjPVarField RETURNNew object

From EMBOSS 6.5.0


AjPVarField: Variation field destructors

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

Functions:
ajVarfieldDelVariation field destructor


Function ajVarfieldDel

Variation field destructor

Prototype

void ajVarfieldDel (
      AjPVarField* Pvar
);

TypeNameRead/WriteDescription
AjPVarField*PvarDeleteVariation field object to delete
void RETURN

From EMBOSS 6.5.0


AjPVarField: variation field modifiers

Variation field modifiers

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


Function ajVarfieldClear

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

Prototype

void ajVarfieldClear (
      AjPVarField var
);

TypeNameRead/WriteDescription
AjPVarFieldvarModifyVariation field object
void RETURN

From EMBOSS 6.5.0


AjPVarField: variation field casts

Variation field casts

Functions:
ajVarfieldGetNumberReturn the header value for the Number field
ajVarfieldGetTypeReturn the header value for the Type field


Function ajVarfieldGetNumber

Return the header value for the Number field

Prototype

const char* ajVarfieldGetNumber (
      const AjPVarField var
);

TypeNameRead/WriteDescription
const AjPVarFieldvarInputVariation field object
const char* RETURNHeader field value

From EMBOSS 6.5.0


Function ajVarfieldGetType

Return the header value for the Type field

Prototype

const char* ajVarfieldGetType (
      const AjPVarField var
);

TypeNameRead/WriteDescription
const AjPVarFieldvarInputVariation field object
const char* RETURNHeader field value

From EMBOSS 6.5.0


Datatype: AjPVarHeader

Function is for manipulating variation header objects

Sections:
constructorsConstructors
Variation header destructorsDestructors
variation header modifiersModifiers


AjPVarHeader: constructors

Constructors

Functions:
ajVarheaderNewVariation header constructor


Function ajVarheaderNew

Variation header constructor

Prototype

AjPVarHeader ajVarheaderNew (
      void
);

TypeNameRead/WriteDescription
AjPVarHeader RETURNNew object

From EMBOSS 6.5.0


AjPVarHeader: Variation header destructors

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

Functions:
ajVarheaderDelVariation header destructor


Function ajVarheaderDel

Variation header destructor

Prototype

void ajVarheaderDel (
      AjPVarHeader* Pvar
);

TypeNameRead/WriteDescription
AjPVarHeader*PvarDeleteVariation header object to delete
void RETURN

From EMBOSS 6.5.0


AjPVarHeader: variation header modifiers

Variation header modifiers

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


Function ajVarheaderClear

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

Prototype

void ajVarheaderClear (
      AjPVarHeader var
);

TypeNameRead/WriteDescription
AjPVarHeadervarModifyVariation header object
void RETURN

From EMBOSS 6.5.0


Datatype: AjPVarSample

Function is for manipulating variation sample objects

Sections:
constructorsConstructors
Variation sample destructorsDestructors
variation sample modifiersModifiers


AjPVarSample: constructors

Constructors

Functions:
ajVarsampleNewVariation sample constructor


Function ajVarsampleNew

Variation sample constructor

Prototype

AjPVarSample ajVarsampleNew (
      void
);

TypeNameRead/WriteDescription
AjPVarSample RETURNNew object

From EMBOSS 6.5.0


AjPVarSample: Variation sample destructors

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

Functions:
ajVarsampleDelVariation sample destructor


Function ajVarsampleDel

Variation sample destructor

Prototype

void ajVarsampleDel (
      AjPVarSample* Pvar
);

TypeNameRead/WriteDescription
AjPVarSample*PvarDeleteVariation sample object to delete
void RETURN

From EMBOSS 6.5.0


AjPVarSample: variation sample modifiers

Variation sample modifiers

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


Function ajVarsampleClear

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

Prototype

void ajVarsampleClear (
      AjPVarSample var
);

TypeNameRead/WriteDescription
AjPVarSamplevarModifyVariation sample object
void RETURN

From EMBOSS 6.5.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