ajtaxwrite.c
Datatypes: AjPFile none
Taxonomy data output
Sections: taxonomy data outputs
These functions write the taxonomy data provided by the first argument
Functions: ajTaxoutWrite
Write a taxon in a named format
Synopsis
Prototype
AjBool ajTaxoutWrite (
AjPOutfile outf,
const AjPTax tax
);
| Type | Name | Read/Write | Description |
|---|
| AjPOutfile | outf | Modify | Output file |
| const AjPTax | tax | Input | Taxon object |
| AjBool | | RETURN | True on success |
Input
Input & Output
Returns
Description
Write a taxon in a named format
See Also
See other functions in this section
Availability
In release 6.4.0
Miscellaneous functions
Sections: Print
Printing to a file
Functions: ajTaxoutprintBook ajTaxoutprintHtml ajTaxoutprintText ajTaxoutprintWiki
Reports the taxonomy format internals as Docbook text
Synopsis
Prototype
void ajTaxoutprintBook (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the taxonomy format internals as Docbook text
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajTaxoutprintHtml (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the internal data structures
Synopsis
Prototype
void ajTaxoutprintText (
AjPFile outf,
AjBool full
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| AjBool | full | Input | Full report (usually ajFalse) |
| void | | RETURN | |
Input
| full: | (Input) | Full report (usually ajFalse) |
Input & Output
Returns
Description
Reports the internal data structures
See Also
See other functions in this section
Availability
In release 6.4.0
Reports the taxonomy output format internals as wikitext
Synopsis
Prototype
void ajTaxoutprintWiki (
AjPFile outf
);
| Type | Name | Read/Write | Description |
|---|
| AjPFile | outf | Modify | Output file |
| void | | RETURN | |
Input & Output
Returns
Description
Reports the taxonomy output format internals as wikitext
See Also
See other functions in this section
Availability
In release 6.4.0
Values for output formats
Functions: ajTaxoutformatFind ajTaxoutformatTest
Looks for the specified format(s) in the internal definitions and
returns the index.
Sets iformat as the recognised format, and returns ajTrue.
Synopsis
Prototype
AjBool ajTaxoutformatFind (
const AjPStr format,
ajint* iformat
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format required. |
| ajint* | iformat | Output | Index |
| AjBool | | RETURN | ajTrue on success. |
Input
| format: | (Input) | Format required. |
Output
Returns
| AjBool: | ajTrue on success. |
Description
Looks for the specified format(s) in the internal definitions and
returns the index.
Sets iformat as the recognised format, and returns ajTrue.
See Also
See other functions in this section
Availability
In release 6.4.0
Tests whether a named taxon output format is known
Synopsis
Prototype
AjBool ajTaxoutformatTest (
const AjPStr format
);
| Type | Name | Read/Write | Description |
|---|
| const AjPStr | format | Input | Format |
| AjBool | | RETURN | ajTrue if formats was accepted |
Input
Returns
| AjBool: | ajTrue if formats was accepted |
Description
Tests whether a named taxon output format is known
See Also
See other functions in this section
Availability
In release 6.4.0
Functions to initialise and clean up internals
Functions: ajTaxoutExit
Cleans up taxonomy output internal memory
Synopsis
Prototype
void ajTaxoutExit (
void
);
| Type | Name | Read/Write | Description |
|---|
| void | | RETURN | |
Returns
Description
Cleans up taxonomy output internal memory
See Also
See other functions in this section
Availability
In release 6.4.0