ajreport.c

Function ajReportDel

Destructor for report objects

Prototype

void ajReportDel (
      AjPReport* pthys
);

TypeNameRead/WriteDescription
AjPReport*pthysDeleteReport object reference
void RETURN

From EMBOSS 2.0.0

Function ajReportOpen

Opens a new report file

Prototype

AjBool ajReportOpen (
      AjPReport thys,
      const AjPStr name
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrnameInputFile name
AjBool RETURNajTrue on success

From EMBOSS 2.0.0

Function ajReportFormatDefault

Sets the default format for a feature report

Prototype

AjBool ajReportFormatDefault (
      AjPStr* pformat
);

TypeNameRead/WriteDescription
AjPStr*pformatOutputDefault format returned
AjBool RETURNajTrue is format was returned

From EMBOSS 2.0.0

Function ajReportFindFormat

Looks for the specified report format in the internal definitions and returns the index.

Prototype

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

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

From EMBOSS 2.0.0

Function ajReportSetTagsS

Sets the tag list for a report

Prototype

AjBool ajReportSetTagsS (
      AjPReport thys,
      const AjPStr taglist
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrtaglistInputTag names list
AjBool RETURNajTrue on success

From EMBOSS 6.2.0

Function ajReportValid

Test for a report object.

Prototype

AjBool ajReportValid (
      AjPReport thys
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
AjBool RETURNajTrue on success

From EMBOSS 2.1.0

Function ajReportNew

Constructor for a report object

Prototype

AjPReport ajReportNew (
      void
);

TypeNameRead/WriteDescription
AjPReport RETURNNew report object

From EMBOSS 2.0.0

Function ajReportWrite

Writes a feature report

Prototype

AjBool ajReportWrite (
      AjPReport thys,
      const AjPFeattable ftable,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPFeattableftableInputFeature table object
const AjPSeqseqInputSequence object
AjBool RETURNTrue if data was written False if maximum output has already been reached.

From EMBOSS 2.0.0

Function ajReportClose

Closes a feature report

Prototype

void ajReportClose (
      AjPReport thys
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
void RETURN

From EMBOSS 2.0.0

Function ajReportWriteHeader

Writes a feature report header and updates internal counters.

Prototype

void ajReportWriteHeader (
      AjPReport thys,
      const AjPFeattable ftable,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPFeattableftableInputFeature table object
const AjPSeqseqInputSequence object
void RETURN

From EMBOSS 2.1.0

Function ajReportWriteTail

Writes (and clears) a feature report tail

Prototype

void ajReportWriteTail (
      AjPReport thys,
      const AjPFeattable ftable,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPFeattableftableInputFeature table object
const AjPSeqseqInputSequence object
void RETURN

From EMBOSS 2.1.0

Function ajReportSetHeaderS

Defines a feature report header

Prototype

void ajReportSetHeaderS (
      AjPReport thys,
      const AjPStr header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrheaderInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetHeaderC

Defines a feature report header

Prototype

void ajReportSetHeaderC (
      AjPReport thys,
      const char* header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*headerInputReport header with embedded newlines
void RETURN

From EMBOSS 2.1.0

Function ajReportAppendHeaderC

Appends to a feature report header

Prototype

void ajReportAppendHeaderC (
      AjPReport thys,
      const char* header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*headerInputReport header with embedded newlines
void RETURN

From EMBOSS 4.1.0

Function ajReportAppendHeaderS

Defines a feature report header

Prototype

void ajReportAppendHeaderS (
      AjPReport thys,
      const AjPStr header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrheaderInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetSubheaderC

Appends to a feature report subheader

Prototype

void ajReportSetSubheaderC (
      AjPReport thys,
      const char* header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*headerInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetSubheaderS

Defines a feature report subheader

Prototype

void ajReportSetSubheaderS (
      AjPReport thys,
      const AjPStr header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrheaderInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportAppendSubheaderC

Appends to a feature report subheader

Prototype

void ajReportAppendSubheaderC (
      AjPReport thys,
      const char* header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*headerInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportAppendSubheaderS

Defines a feature report subheader

Prototype

void ajReportAppendSubheaderS (
      AjPReport thys,
      const AjPStr header
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrheaderInputReport header with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetSeqstats

Defines a feature report tail

Prototype

void ajReportSetSeqstats (
      AjPReport thys,
      const AjPSeqall seqall
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPSeqallseqallInputSequence stream object
void RETURN

From EMBOSS 6.1.0

Function ajReportSetSeqsetstats

Defines a feature report tail

Prototype

void ajReportSetSeqsetstats (
      AjPReport thys,
      const AjPSeqset seqset
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPSeqsetseqsetInputSequence set object
void RETURN

From EMBOSS 6.1.0

Function ajReportSetStatistics

Defines a feature report tail

Prototype

void ajReportSetStatistics (
      AjPReport thys,
      ajlong totseqs,
      ajlong totlength
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
ajlongtotseqsInputTotal number of sequences processed
ajlongtotlengthInputTotal sequence length processed
void RETURN

From EMBOSS 6.1.0

Function ajReportSetTailC

Defines a feature report tail

Prototype

void ajReportSetTailC (
      AjPReport thys,
      const char* tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*tailInputReport tail with embedded newlines
void RETURN

From EMBOSS 2.1.0

Function ajReportSetTailS

Defines a feature report tail

Prototype

void ajReportSetTailS (
      AjPReport thys,
      const AjPStr tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrtailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportAppendTailC

Appends to a feature report tail

Prototype

void ajReportAppendTailC (
      AjPReport thys,
      const char* tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*tailInputReport tail with embedded newlines
void RETURN

From EMBOSS 4.1.0

Function ajReportAppendTailS

Appends to a feature report tail

Prototype

void ajReportAppendTailS (
      AjPReport thys,
      const AjPStr tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrtailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetSubtailC

Defines a feature report subtail

Prototype

void ajReportSetSubtailC (
      AjPReport thys,
      const char* tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*tailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetSubtailS

Defines a feature report subtail

Prototype

void ajReportSetSubtailS (
      AjPReport thys,
      const AjPStr tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrtailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportAppendSubtailC

Appends to a feature report subtail

Prototype

void ajReportAppendSubtailC (
      AjPReport thys,
      const char* tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const char*tailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportAppendSubtailS

Appends to a feature report subtail

Prototype

void ajReportAppendSubtailS (
      AjPReport thys,
      const AjPStr tail
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPStrtailInputReport tail with embedded newlines
void RETURN

From EMBOSS 6.2.0

Function ajReportSetType

Sets the report type (if it is not set already)

Prototype

void ajReportSetType (
      AjPReport thys,
      const AjPFeattable ftable,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
const AjPFeattableftableInputFeature table object
const AjPSeqseqInputSequence object
void RETURN

From EMBOSS 2.1.0

Function ajReportGetSeqnameSeq

Returns the sequence name or USA depending on the setting in the report object (derived from the ACD and command line -rusa option)

Prototype

const AjPStr ajReportGetSeqnameSeq (
      const AjPReport thys,
      const AjPSeq seq
);

TypeNameRead/WriteDescription
const AjPReportthysInputReport object
const AjPSeqseqInputSequence object
const AjPStr RETURNSequence name for this report

From EMBOSS 6.2.0

Function ajReportAddFileF

Adds an additional file name and description to the report.

Prototype

void ajReportAddFileF (
      AjPReport thys,
      AjPFile file,
      const AjPStr type
);

TypeNameRead/WriteDescription
AjPReportthysModifyReport object
AjPFilefileModifyFile
const AjPStrtypeInputType (simple text description)
void RETURN

From EMBOSS 6.2.0

Function ajReportPrintFormat

Reports the internal data structures

Prototype

void ajReportPrintFormat (
      AjPFile outf,
      AjBool full
);

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

From EMBOSS 2.5.0

Function ajReportPrinthtmlFormat

Reports the internal data structures

Prototype

void ajReportPrinthtmlFormat (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.4.0

Function ajReportPrintbookFormat

Reports the report format internals in DocBook format

Prototype

void ajReportPrintbookFormat (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.2.0

Function ajReportPrintwikiFormat

Reports the report format internals as wikitext

Prototype

void ajReportPrintwikiFormat (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

From EMBOSS 6.2.0

Function ajReportDummyFunction

Dummy function to catch all unused functions defined in the ajreport source file.

Prototype

void ajReportDummyFunction (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 2.9.0

Function ajReportExit

Cleans up report processing internal memory

Prototype

void ajReportExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

From EMBOSS 4.0.0