ajassemread.c

Datatypes: AjPAssemin none AjPTable none

Datatype: AjPAssemin

Assembly input objects

Sections: Assembly Input Constructors Assembly Input Destructors assembly input modifiers casts Assembly data inputs

Section: Assembly Input Constructors

All constructors return a new assembly input object by pointer. It is the responsibility of the user to first destroy any previous assembly input object. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions: ajAsseminNew

Function ajAsseminNew

Creates a new assembly input object.

Synopsis

Prototype
AjPAssemin ajAsseminNew (
      void
);

TypeNameRead/WriteDescription
AjPAssemin RETURNNew assembly input object.

Returns
AjPAssemin:New assembly input object.

Description

Creates a new assembly input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Assembly Input Destructors

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

Functions: ajAsseminDel

Function ajAsseminDel

Deletes an assembly input object.

Synopsis

Prototype
void ajAsseminDel (
      AjPAssemin* pthis
);

TypeNameRead/WriteDescription
AjPAssemin*pthisDeleteAssembly input
void RETURN

Output
pthis:(Delete)Assembly input
Returns
void:No return value

Description

Deletes an assembly input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: assembly input modifiers

These functions use the contents of an assembly input object and update them.

Functions: ajAsseminClear ajAsseminQryC ajAsseminQryS

Function ajAsseminClear

Clears an assembly input object back to "as new" condition, except for the query list which must be preserved.

Synopsis

Prototype
void ajAsseminClear (
      AjPAssemin thys
);

TypeNameRead/WriteDescription
AjPAsseminthysOutputAssembly input
void RETURN

Output
thys:(Output)Assembly input
Returns
void:No return value

Description

Clears an assembly input object back to "as new" condition, except for the query list which must be preserved.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminQryC

Resets an assembly input object using a new Universal Query Address

Synopsis

Prototype
void ajAsseminQryC (
      AjPAssemin thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPAsseminthysModifyAssembly input object.
const char*txtInputQuery
void RETURN

Input
txt:(Input)Query
Input & Output
thys:(Modify)Assembly input object.
Returns
void:No return value

Description

Resets an assembly input object using a new Universal Query Address

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminQryS

Resets an assembly input object using a new Universal Query Address

Synopsis

Prototype
void ajAsseminQryS (
      AjPAssemin thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPAsseminthysModifyAssembly input object.
const AjPStrstrInputQuery
void RETURN

Input
str:(Input)Query
Input & Output
thys:(Modify)Assembly input object.
Returns
void:No return value

Description

Resets an assembly input object using a new Universal Query Address

See Also

See other functions in this section

Availability

In release 6.4.0

Section: casts

Return values

Functions: ajAsseminTrace

Function ajAsseminTrace

Debug calls to trace the data in an assembly input object.

Synopsis

Prototype
void ajAsseminTrace (
      const AjPAssemin thys
);

TypeNameRead/WriteDescription
const AjPAsseminthysInputAssembly input object.
void RETURN

Input
thys:(Input)Assembly input object.
Returns
void:No return value

Description

Debug calls to trace the data in an assembly input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Assembly data inputs

These functions read the assembly data provided by the first argument

Functions: ajAsseminRead

Function ajAsseminRead

If the file is not yet open, calls asseminQryProcess to convert the query into an open file stream.

Uses asseminRead for the actual file reading.

Returns the results in the AjPAssem object.

Synopsis

Prototype
AjBool ajAsseminRead (
      AjPAssemin assemin,
      AjPAssem assem
);

TypeNameRead/WriteDescription
AjPAsseminasseminModifyassembly data input definitions
AjPAssemassemOutputassembly data returned.
AjBool RETURNajTrue on success.

Output
assem:(Output)assembly data returned.
Input & Output
assemin:(Modify)assembly data input definitions
Returns
AjBool:ajTrue on success.

Description

If the file is not yet open, calls asseminQryProcess to convert the query into an open file stream.

Uses asseminRead for the actual file reading.

Returns the results in the AjPAssem object.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous

Sections: Print Miscellaneous Internals

Section: Print

Printing to a file

Functions: ajAsseminprintBook ajAsseminprintHtml ajAsseminprintText ajAsseminprintWiki

Function ajAsseminprintBook

Reports the internal data structures as a Docbook table

Synopsis

Prototype
void ajAsseminprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as a Docbook table

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminprintHtml

Reports the internal data structures as an HTML table

Synopsis

Prototype
void ajAsseminprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as an HTML table

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminprintText

Reports the internal data structures

Synopsis

Prototype
void ajAsseminprintText (
      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

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminprintWiki

Reports the internal data structures as a wiki table

Synopsis

Prototype
void ajAsseminprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as a wiki table

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions: ajAsseminExit

Function ajAsseminExit

Cleans up assembly input internal memory

Synopsis

Prototype
void ajAsseminExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up assembly input internal memory

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Internals

Functions to return internal values

Functions: ajAsseminTypeGetFields ajAsseminTypeGetQlinks

Function ajAsseminTypeGetFields

Returns the listof known field names for ajAsseminRead

Synopsis

Prototype
const char* ajAsseminTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the listof known field names for ajAsseminRead

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminTypeGetQlinks

Returns the listof known query link operators for ajAsseminRead

Synopsis

Prototype
const char* ajAsseminTypeGetQlinks (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the listof known query link operators for ajAsseminRead

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPTable

Internal call register table

Sections: Cast

Section: Cast

Return a reference to the call table

Functions: ajAssemaccessGetDb ajAssemaccessMethodGetQlinks ajAssemaccessMethodGetScope ajAssemaccessMethodTest

Function ajAssemaccessGetDb

Returns the table in which assembly database access details are registered

Synopsis

Prototype
AjPTable ajAssemaccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

Returns
AjPTable:Access functions hash table

Description

Returns the table in which assembly database access details are registered

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAssemaccessMethodGetQlinks

Tests for a named method for assembly data reading returns the known query link operators

Synopsis

Prototype
const char* ajAssemaccessMethodGetQlinks (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
const char* RETURNKnown link operators

Input
method:(Input)Method required.
Returns
const char*:Known link operators

Description

Tests for a named method for assembly data reading returns the known query link operators

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAssemaccessMethodGetScope

Tests for a named method for assembly data reading and returns the scope (entry, query or all).

Synopsis

Prototype
ajuint ajAssemaccessMethodGetScope (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
ajuint RETURNScope flags

Input
method:(Input)Method required.
Returns
ajuint:Scope flags

Description

Tests for a named method for assembly data reading and returns the scope (entry, query or all).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAssemaccessMethodTest

Tests for a named method for assembly data reading.

Synopsis

Prototype
AjBool ajAssemaccessMethodTest (
      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 assembly data reading.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Input formats

Sections: cast

Section: cast

Values for input formats

Functions: ajAsseminformatTerm ajAsseminformatTest

Function ajAsseminformatTerm

Tests whether a assembly data input format term is known

Synopsis

Prototype
AjBool ajAsseminformatTerm (
      const AjPStr term
);

TypeNameRead/WriteDescription
const AjPStrtermInputFormat term EDAM ID
AjBool RETURNajTrue if formats was accepted

Input
term:(Input)Format term EDAM ID
Returns
AjBool:ajTrue if formats was accepted

Description

Tests whether a assembly data input format term is known

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAsseminformatTest

Tests whether a named assembly data input format is known

Synopsis

Prototype
AjBool ajAsseminformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if format was accepted

Input
format:(Input)Format
Returns
AjBool:ajTrue if format was accepted

Description

Tests whether a named assembly data input format is known

See Also

See other functions in this section

Availability

In release 6.4.0