ajassemwrite.c

Datatypes:
AjPFile Assembly data output
none Miscellaneous functions


Datatype: AjPFile

Function is for manipulating assembly data objects

Sections:
assembly data outputsOutput


AjPFile: assembly data outputs

These functions write the assembly data provided by the first argument

Functions:
ajAssemoutWriteWrite assembly data in a named format
ajAssemoutWriteNextWrite latest chunk of assembly data in a named format


Function ajAssemoutWrite

Write assembly data in a named format

Prototype

AjBool ajAssemoutWrite (
      AjPOutfile outf,
      const AjPAssem assem
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPAssemassemInputAssembly data object
AjBool RETURNTrue on success

From EMBOSS 6.5.0


Function ajAssemoutWriteNext

Write latest chunk of assembly data in a named format

Prototype

AjBool ajAssemoutWriteNext (
      AjPOutfile outf,
      const AjPAssem assem
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPAssemassemInputAssembly data object
AjBool RETURNTrue on success

From EMBOSS 6.5.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts


Section: Print

Printing to a file

Functions:
ajAssemoutprintBookReports the assembly format internals as Docbook text
ajAssemoutprintHtmlReports the internal data structures
ajAssemoutprintTextReports the internal data structures
ajAssemoutprintWikiReports the asembly output format internals as wikitext


Function ajAssemoutprintBook

Reports the assembly format internals as Docbook text

Prototype

void ajAssemoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajAssemoutprintHtml

Reports the internal data structures

Prototype

void ajAssemoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajAssemoutprintText

Reports the internal data structures

Prototype

void ajAssemoutprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0


Function ajAssemoutprintWiki

Reports the asembly output format internals as wikitext

Prototype

void ajAssemoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajAssemoutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajAssemoutformatTestTests whether a named assembly output format is known


Function ajAssemoutformatFind

Looks for the specified format(s) in the internal definitions and returns the index.

Prototype

AjBool ajAssemoutformatFind (
      const AjPStr format,
      ajint* iformat
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat required.
ajint*iformatOutputIndex
AjBool RETURNajTrue on success.

From EMBOSS 6.4.0


Function ajAssemoutformatTest

Tests whether a named assembly output format is known

Prototype

AjBool ajAssemoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

From EMBOSS 6.4.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajAssemoutExitCleans up assembly output internal memory


Function ajAssemoutExit

Cleans up assembly output internal memory

Prototype

void ajAssemoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0