ajrefseq.c

Datatypes:

AjPRefseq	Reference sequence data
none	Miscellaneous functions

Datatype: AjPRefseq

Sections:

constructors	Constructors
Reference sequence data destructors	Destructors
Casts	Casts
reference sequence data modifiers	Modifiers

AjPRefseq: constructors

Functions:

ajRefseqNew

Refseq data constructor

Function ajRefseqNew

Prototype

AjPRefseq ajRefseqNew (
      void
);

Type	Name	Read/Write	Description
AjPRefseq		RETURN	New object

In release 6.5.0

AjPRefseq: Reference sequence data destructors

Functions:

ajRefseqDel

Reference sequence data destructor

Function ajRefseqDel

Prototype

void ajRefseqDel (
      AjPRefseq* Prefseq
);

Type	Name	Read/Write	Description
AjPRefseq*	Prefseq	Delete	Reference sequence data object to delete
void		RETURN

In release 6.5.0

AjPRefseq: Casts

Functions:

ajRefseqGetDb	Return the database name
ajRefseqGetId	Return the identifier
ajRefseqGetQryC	Returns the query string of a reference sequence 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.
ajRefseqGetQryS	Returns the query string of a reference sequence 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 ajRefseqGetDb

Prototype

const AjPStr ajRefseqGetDb (
      const AjPRefseq refseq
);

Type	Name	Read/Write	Description
const AjPRefseq	refseq	Input	Refseq
const AjPStr		RETURN	Database name

In release 6.5.0

Function ajRefseqGetId

Prototype

const AjPStr ajRefseqGetId (
      const AjPRefseq refseq
);

Type	Name	Read/Write	Description
const AjPRefseq	refseq	Input	Refseq
const AjPStr		RETURN	Returned id

In release 6.5.0

Function ajRefseqGetQryC

Prototype

const char* ajRefseqGetQryC (
      const AjPRefseq refseq
);

Type	Name	Read/Write	Description
const AjPRefseq	refseq	Input	Reference sequence data object.
const char*		RETURN	Query as a character string.

In release 6.5.0

Function ajRefseqGetQryS

Prototype

const AjPStr ajRefseqGetQryS (
      const AjPRefseq refseq
);

Type	Name	Read/Write	Description
const AjPRefseq	refseq	Input	Reference sequence data object.
const AjPStr		RETURN	Query as a string.

In release 6.5.0

AjPRefseq: reference sequence data modifiers

Functions:

ajRefseqClear

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

Function ajRefseqClear

Prototype

void ajRefseqClear (
      AjPRefseq refseq
);

Type	Name	Read/Write	Description
AjPRefseq	refseq	Modify	Reference sequence data object
void		RETURN

In release 6.5.0

Datatype: none

Sections:

exit	Miscellaneous

Section: exit

Functions:

ajRefseqExit

Cleans up reference sequence processing internal memory

Function ajRefseqExit

Prototype

void ajRefseqExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

In release 6.5.0