ajassem.c

Datatypes:
AjPAssem Assembly data
none Miscellaneous functions


Datatype: AjPAssem

Function is for manipulating assembly data objects

Sections:
constructorsConstructors
Assem data destructorsDestructors
CastsCasts
assembly data modifiersModifiers


AjPAssem: constructors

Constructors

Functions:
ajAssemNewAssem data constructor


Function ajAssemNew

Assem data constructor

Prototype

AjPAssem ajAssemNew (
      void
);

TypeNameRead/WriteDescription
AjPAssem RETURNNew object

From EMBOSS 6.4.0


AjPAssem: Assem data destructors

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

Functions:
ajAssemDelAssem data destructor


Function ajAssemDel

Assem data destructor

Prototype

void ajAssemDel (
      AjPAssem* Passem
);

TypeNameRead/WriteDescription
AjPAssem*PassemDeleteAssem data object to delete
void RETURN

From EMBOSS 6.4.0


AjPAssem: Casts

Return values from an assembly data object

Functions:
ajAssemGetQryCReturns the query string of an assembly 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.
ajAssemGetQrySReturns the query string of an assembly 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 ajAssemGetQryC

Returns the query string of an assembly 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* ajAssemGetQryC (
      const AjPAssem assem
);

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

From EMBOSS 6.4.0


Function ajAssemGetQryS

Returns the query string of an assembly 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 ajAssemGetQryS (
      const AjPAssem assem
);

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

From EMBOSS 6.4.0


AjPAssem: assembly data modifiers

Assem data modifiers

Functions:
ajAssemClearResets all data for an assembly data object so that it can be reused.


Function ajAssemClear

Resets all data for an assembly data object so that it can be reused.

Prototype

void ajAssemClear (
      AjPAssem assem
);

TypeNameRead/WriteDescription
AjPAssemassemModifyassem data
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:
ajAssemExitCleans up assembly processing internal memory


Function ajAssemExit

Cleans up assembly processing internal memory

Prototype

void ajAssemExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0