ajseqdb.c

Function ajSeqMethodTest

Tests for a named method for sequence reading.

Synopsis

Prototype
AjBool ajSeqMethodTest (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
AjBool RETURNajTrue on success.

Input
method:(Input)Method required.
Returns
AjBool:ajTrue on success.

Description

Tests for a named method for sequence reading.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajSeqMethod

Sets the access function for a named method for sequence reading.

Synopsis

Prototype
SeqPAccess ajSeqMethod (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
SeqPAccess RETURNAccess function to use

Input
method:(Input)Method required.
Returns
SeqPAccess:Access function to use

Description

Sets the access function for a named method for sequence reading.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Section: ASIS Sequence Access

These functions manage the ASIS sequence access methods.

Functions: ajSeqAccessAsis

Function ajSeqAccessAsis

Reads a sequence using the 'filename' as the sequence data.

Synopsis

Prototype
AjBool ajSeqAccessAsis (
      AjPSeqin seqin
);

TypeNameRead/WriteDescription
AjPSeqinseqinModifySequence input.
AjBool RETURNajTrue on success.

Input & Output
seqin:(Modify)Sequence input.
Returns
AjBool:ajTrue on success.

Description

Reads a sequence using the 'filename' as the sequence data.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Section: File Access

These functions manage the sequence file access methods.

Functions: ajSeqAccessFile ajSeqAccessOffset

Function ajSeqAccessFile

Reads a sequence from a named file.

Synopsis

Prototype
AjBool ajSeqAccessFile (
      AjPSeqin seqin
);

TypeNameRead/WriteDescription
AjPSeqinseqinModifySequence input.
AjBool RETURNajTrue on success.

Input & Output
seqin:(Modify)Sequence input.
Returns
AjBool:ajTrue on success.

Description

Reads a sequence from a named file.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajSeqAccessOffset

Reads a sequence from a named file, at a given offset within the file.

Synopsis

Prototype
AjBool ajSeqAccessOffset (
      AjPSeqin seqin
);

TypeNameRead/WriteDescription
AjPSeqinseqinModifySequence input.
AjBool RETURNajTrue on success.

Input & Output
seqin:(Modify)Sequence input.
Returns
AjBool:ajTrue on success.

Description

Reads a sequence from a named file, at a given offset within the file.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Section: File Direct Access

These functions manage the sequence file direct access methods.

Functions: ajSeqPrintAccess ajSeqDbExit

Function ajSeqPrintAccess

Reports the internal data structures

Synopsis

Prototype
void ajSeqPrintAccess (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

Input
full:(Input)Full report (usually ajFalse)
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajSeqDbExit

Cleans up sequence database processing internal memory

Synopsis

Prototype
void ajSeqDbExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up sequence database processing internal memory

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0