ajresourcewrite.c

Datatypes:
AjPOutfile Data resource data output
none Miscellaneous functions


Datatype: AjPOutfile

Function is for manipulating data resource data objects

Sections:
data resource data outputsOutput


AjPOutfile: data resource data outputs

These functions write the data resource data provided by the first argument

Functions:
ajResourceoutWriteWrite a data resource in a named format


Function ajResourceoutWrite

Write a data resource in a named format

Prototype

AjBool ajResourceoutWrite (
      AjPOutfile outf,
      const AjPResource resource
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPResourceresourceInputData resource object
AjBool RETURNTrue on success

From EMBOSS 6.4.0


Datatype: none

Functions to initialise and clean up internals

Sections:
PrintCasts
MiscellaneousMiscellaneous


Section: Print

Printing to a file

Functions:
ajResourceoutprintBookReports the resource format internals as Docbook text
ajResourceoutprintHtmlReports the internal data structures
ajResourceoutprintTextReports the internal data structures
ajResourceoutprintWikiReports the data resource output format internals as wikitext


Function ajResourceoutprintBook

Reports the resource format internals as Docbook text

Prototype

void ajResourceoutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajResourceoutprintHtml

Reports the internal data structures

Prototype

void ajResourceoutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajResourceoutprintText

Reports the internal data structures

Prototype

void ajResourceoutprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0


Function ajResourceoutprintWiki

Reports the data resource output format internals as wikitext

Prototype

void ajResourceoutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: Miscellaneous

Functions to initialise and clean up internals

Functions:
ajResourceoutExitCleans up data output internal memory


Function ajResourceoutExit

Cleans up data output internal memory

Prototype

void ajResourceoutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajResourceoutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajResourceoutformatTestTests whether a named data resource output format is known


Function ajResourceoutformatFind

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

Prototype

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

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

From EMBOSS 6.4.0


Function ajResourceoutformatTest

Tests whether a named data resource output format is known

Prototype

AjBool ajResourceoutformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if formats was accepted

From EMBOSS 6.4.0