ajvarwrite.c

Datatypes:
AjPoutfile Variation data output
none Miscellaneous functions


Datatype: AjPoutfile

Function is for manipulating variation data objects

Sections:
variation data outputsOutput


AjPoutfile: variation data outputs

These functions write the variation data provided by the first argument

Functions:
ajVaroutWriteWrite variation data in a named format
ajVaroutWriteNextWrite latest chunk of variation data in a named format


Function ajVaroutWrite

Write variation data in a named format

Prototype

AjBool ajVaroutWrite (
      AjPOutfile outf,
      const AjPVar var
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPVarvarInputVariation object
AjBool RETURNTrue on success

From EMBOSS 6.4.0


Function ajVaroutWriteNext

Write latest chunk of variation data in a named format

Prototype

AjBool ajVaroutWriteNext (
      AjPOutfile outf,
      const AjPVar var
);

TypeNameRead/WriteDescription
AjPOutfileoutfModifyOutput file
const AjPVarvarInputVariation 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:
ajVaroutprintBookReports the variation format internals as Docbook text
ajVaroutprintHtmlReports the internal data structures
ajVaroutprintTextReports the internal data structures
ajVaroutprintWikiReports the variation output format internals as wikitext


Function ajVaroutprintBook

Reports the variation format internals as Docbook text

Prototype

void ajVaroutprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajVaroutprintHtml

Reports the internal data structures

Prototype

void ajVaroutprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Function ajVaroutprintText

Reports the internal data structures

Prototype

void ajVaroutprintText (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 6.4.0


Function ajVaroutprintWiki

Reports the variation output format internals as wikitext

Prototype

void ajVaroutprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0


Section: cast

Values for output formats

Functions:
ajVaroutformatFindLooks for the specified format(s) in the internal definitions and returns the index.
ajVaroutformatTestTests whether a named variation output format is known


Function ajVaroutformatFind

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

Prototype

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

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

From EMBOSS 6.4.0


Function ajVaroutformatTest

Tests whether a named variation output format is known

Prototype

AjBool ajVaroutformatTest (
      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:
ajVaroutExitCleans up variation output internal memory


Function ajVaroutExit

Cleans up variation output internal memory

Prototype

void ajVaroutExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 6.4.0