ajfeatwrite.c

Function ajFeattabOutOpen

Processes the specified UFO, and opens the resulting output file.

Prototype

AjBool ajFeattabOutOpen (
      AjPFeattabOut thys,
      const AjPStr ufo
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Features table output object

const AjPStr ufo Input UFO feature output specifier

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Features table output object
`const AjPStr`	`ufo`	Input	UFO feature output specifier
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattabOutFile

Returns the feature table output file object

Prototype

AjPFile ajFeattabOutFile (
      const AjPFeattabOut thys
);

Type Name Read/Write Description

const AjPFeattabOut thys Input Features table output object

AjPFile RETURN File object

Type	Name	Read/Write	Description
`const AjPFeattabOut`	`thys`	Input	Features table output object
`AjPFile`		RETURN	File object

From EMBOSS 2.1.0

Function ajFeattabOutFilename

Returns the name of a feature table output file

Prototype

AjPStr ajFeattabOutFilename (
      const AjPFeattabOut thys
);

Type Name Read/Write Description

const AjPFeattabOut thys Input Features table output object

AjPStr RETURN Filename

Type	Name	Read/Write	Description
`const AjPFeattabOut`	`thys`	Input	Features table output object
`AjPStr`		RETURN	Filename

From EMBOSS 2.1.0

Function ajFeattabOutIsOpen

Checks whether feature output file has already been opened

Prototype

AjBool ajFeattabOutIsOpen (
      const AjPFeattabOut thys
);

Type Name Read/Write Description

const AjPFeattabOut thys Input Features table output object

AjBool RETURN ajTrue if file is open

Type	Name	Read/Write	Description
`const AjPFeattabOut`	`thys`	Input	Features table output object
`AjBool`		RETURN	ajTrue if file is open

From EMBOSS 2.0.1

Function ajFeattabOutIsLocal

Checks whether feature output file has already been opened

Prototype

AjBool ajFeattabOutIsLocal (
      const AjPFeattabOut thys
);

Type Name Read/Write Description

const AjPFeattabOut thys Input Features table output object

AjBool RETURN ajTrue if file is open

Type	Name	Read/Write	Description
`const AjPFeattabOut`	`thys`	Input	Features table output object
`AjBool`		RETURN	ajTrue if file is open

From EMBOSS 2.8.0

Function ajFeattabOutSet

Processes the specified UFO, and specifies the resulting output file.

Prototype

AjBool ajFeattabOutSet (
      AjPFeattabOut thys,
      const AjPStr ufo
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Features table output object

const AjPStr ufo Input UFO feature output specifier

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Features table output object
`const AjPStr`	`ufo`	Input	UFO feature output specifier
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.1

Function ajFeattabOutSetBasename

Sets the base output filename for feature table output

Prototype

void ajFeattabOutSetBasename (
      AjPFeattabOut thys,
      const AjPStr basename
);

Type Name Read/Write Description

AjPFeattabOut thys Modify feature table output

const AjPStr basename Input Output base filename

void RETURN

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	feature table output
`const AjPStr`	`basename`	Input	Output base filename
`void`		RETURN

From EMBOSS 2.7.0

Function ajFeattabOutSetSeqname

Processes the specified UFO, and specifies the resulting output file.

Prototype

AjBool ajFeattabOutSetSeqname (
      AjPFeattabOut thys,
      const AjPStr name
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Features table output object

const AjPStr name Input UFO feature output specifier

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Features table output object
`const AjPStr`	`name`	Input	UFO feature output specifier
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.1.0

Function ajFeattabOutNewCSF

Constructor for an empty feature table output object, using an existing open output file (the file sequence data is already written to)

Prototype

AjPFeattabOut ajFeattabOutNewCSF (
      const char* fmt,
      const AjPStr name,
      const char* type,
      AjPFile file
);

Type Name Read/Write Description

const char* fmt Input feature format

const AjPStr name Input sequence name

const char* type Input feature type

AjPFile file Modify Output file

AjPFeattabOut RETURN Feature table output object

Type	Name	Read/Write	Description
`const char*`	`fmt`	Input	feature format
`const AjPStr`	`name`	Input	sequence name
`const char*`	`type`	Input	feature type
`AjPFile`	`file`	Modify	Output file
`AjPFeattabOut`		RETURN	Feature table output object

From EMBOSS 6.0.0

Function ajFeattabOutNewSSF

Constructor for an empty feature table output object, using an existing open output file (the file sequence data is already written to)

Prototype

AjPFeattabOut ajFeattabOutNewSSF (
      const AjPStr fmt,
      const AjPStr name,
      const char* type,
      AjPFile file
);

Type Name Read/Write Description

const AjPStr fmt Input feature format

const AjPStr name Input sequence name

const char* type Input feature type

AjPFile file Modify Output file

AjPFeattabOut RETURN Feature table output object

Type	Name	Read/Write	Description
`const AjPStr`	`fmt`	Input	feature format
`const AjPStr`	`name`	Input	sequence name
`const char*`	`type`	Input	feature type
`AjPFile`	`file`	Modify	Output file
`AjPFeattabOut`		RETURN	Feature table output object

From EMBOSS 2.0.0

Function ajFeattabOutNew

Constructor for an empty feature table output object

Prototype

AjPFeattabOut ajFeattabOutNew (
      void
);

Type Name Read/Write Description

AjPFeattabOut RETURN Feature table input object

Type	Name	Read/Write	Description
`AjPFeattabOut`		RETURN	Feature table input object

From EMBOSS 2.0.0

Function ajFeattabOutClear

Clears all data for a feature table output object

Prototype

void ajFeattabOutClear (
      AjPFeattabOut* thys
);

Type Name Read/Write Description

AjPFeattabOut* thys Delete feature format

void RETURN Feature table output object

Type	Name	Read/Write	Description
`AjPFeattabOut*`	`thys`	Delete	feature format
`void`		RETURN	Feature table output object

From EMBOSS 4.1.0

Function ajFeattabOutDel

Destructor for a feature table output object

Prototype

void ajFeattabOutDel (
      AjPFeattabOut* pthis
);

Type Name Read/Write Description

AjPFeattabOut* pthis Delete feature format

void RETURN Feature table output object

Type	Name	Read/Write	Description
`AjPFeattabOut*`	`pthis`	Delete	feature format
`void`		RETURN	Feature table output object

From EMBOSS 2.1.0

Function ajFeattableWriteUfo

Parses a UFO, opens an output file, and writes a feature table to it.

Prototype

AjBool ajFeattableWriteUfo (
      AjPFeattabOut thys,
      const AjPFeattable ftable,
      const AjPStr ufo
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Feature output object

const AjPFeattable ftable Input Feature table to be written

const AjPStr ufo Input UFO feature spec (ignored if already open)

AjBool RETURN ajTrue on success.

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Feature output object
`const AjPFeattable`	`ftable`	Input	Feature table to be written
`const AjPStr`	`ufo`	Input	UFO feature spec (ignored if already open)
`AjBool`		RETURN	ajTrue on success.

From EMBOSS 6.2.0

Function ajFeatOutFormatDefault

Sets the default output format. Checks the _OUTFEATFORMAT variable, and uses GFF3 if no other definition is found.

Prototype

AjBool ajFeatOutFormatDefault (
      AjPStr* pformat
);

Type Name Read/Write Description

AjPStr* pformat Output Default output feature format.

AjBool RETURN ajTrue on success.

Type	Name	Read/Write	Description
`AjPStr*`	`pformat`	Output	Default output feature format.
`AjBool`		RETURN	ajTrue on success.

From EMBOSS 2.7.0

Function ajFeattableWrite

Generic interface function for writing features to a file defined by a feature table output object.

Prototype

AjBool ajFeattableWrite (
      AjPFeattabOut ftout,
      const AjPFeattable features
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Specifies the external source (file) of the features to be written

const AjPFeattable features Input Feature set to be written out

AjBool RETURN Returns ajTrue if successful; ajFalse otherwise

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Specifies the external source (file) of the features to be written
`const AjPFeattable`	`features`	Input	Feature set to be written out
`AjBool`		RETURN	Returns ajTrue if successful; ajFalse otherwise

From EMBOSS 2.0.0

Function ajFeattableWriteGff2

Write feature table in GFF 2.0 format

Prototype

AjBool ajFeattableWriteGff2 (
      AjPFeattabOut ftout,
      const AjPFeattable Feattab
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable Feattab Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`Feattab`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFeattableWriteGff3

Write feature table in GFF format

Prototype

AjBool ajFeattableWriteGff3 (
      AjPFeattabOut ftout,
      const AjPFeattable Feattab
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable Feattab Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`Feattab`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFeattableWriteBed

Write feature table in BED format

Prototype

AjBool ajFeattableWriteBed (
      AjPFeattabOut ftout,
      const AjPFeattable Feattab
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable Feattab Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`Feattab`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.5.0

Function ajFeattableWriteDdbj

Write a feature table in DDBJ format.

Prototype

AjBool ajFeattableWriteDdbj (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattableWriteEmbl

Write a feature table in EMBL format.

Prototype

AjBool ajFeattableWriteEmbl (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattableWriteGenbank

Write a feature table in GenBank format.

Prototype

AjBool ajFeattableWriteGenbank (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattableWriteRefseq

Write a feature table in Refseq format.

Prototype

AjBool ajFeattableWriteRefseq (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.2.0

Function ajFeattableWriteRefseqp

Write a feature table in Refseqp format.

Prototype

AjBool ajFeattableWriteRefseqp (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.2.0

Function ajFeattableWriteSwiss

Write a feature table in SwissProt format.

Prototype

AjBool ajFeattableWriteSwiss (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattableWritePir

Write a feature table in PIR format.

Prototype

AjBool ajFeattableWritePir (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.0.0

Function ajFeattableWriteDasgff

Write a feature table in DAS GFF format.

Prototype

AjBool ajFeattableWriteDasgff (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable thys Input Feature table

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`thys`	Input	Feature table
`AjBool`		RETURN	ajTrue on success

From EMBOSS 6.1.0

Function ajFeattableWriteDraw

Writes a report in Draw format, for use as input to cirdna or lindna

Prototype

AjBool ajFeattableWriteDraw (
      AjPFeattabOut ftout,
      const AjPFeattable thys
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Features table output object

const AjPFeattable thys Input Feature table object

AjBool RETURN True on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Features table output object
`const AjPFeattable`	`thys`	Input	Feature table object
`AjBool`		RETURN	True on success

From EMBOSS 6.5.0

Function ajFeattabOutSetType

Sets the type for feature output

Prototype

AjBool ajFeattabOutSetType (
      AjPFeattabOut thys,
      const AjPStr type
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Feature output object

const AjPStr type Input Feature type "nucleotide" "protein"

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Feature output object
`const AjPStr`	`type`	Input	Feature type "nucleotide" "protein"
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.7.0

Function ajFeattabOutSetTypeC

Sets the type for feature output

Prototype

AjBool ajFeattabOutSetTypeC (
      AjPFeattabOut thys,
      const char* type
);

Type Name Read/Write Description

AjPFeattabOut thys Modify Feature output object

const char* type Input Feature type "nucleotide" "protein"

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPFeattabOut`	`thys`	Modify	Feature output object
`const char*`	`type`	Input	Feature type "nucleotide" "protein"
`AjBool`		RETURN	ajTrue on success

From EMBOSS 2.7.0

Function ajFeattableWriteDebug

Print contents of a feature table to a file

Prototype

AjBool ajFeattableWriteDebug (
      AjPFeattabOut ftout,
      const AjPFeattable ftable
);

Type Name Read/Write Description

AjPFeattabOut ftout Modify Feature table output object

const AjPFeattable ftable Input Feature table

AjBool RETURN Always true

Type	Name	Read/Write	Description
`AjPFeattabOut`	`ftout`	Modify	Feature table output object
`const AjPFeattable`	`ftable`	Input	Feature table
`AjBool`		RETURN	Always true

From EMBOSS 6.1.0

Function ajFeattablePrint

Print contents of a feature table to a file

Prototype

AjBool ajFeattablePrint (
      const AjPFeattable ftable,
      AjPFile outf
);

Type Name Read/Write Description

const AjPFeattable ftable Input Feature table

AjPFile outf Modify Output file object

AjBool RETURN Always true

Type	Name	Read/Write	Description
`const AjPFeattable`	`ftable`	Input	Feature table
`AjPFile`	`outf`	Modify	Output file object
`AjBool`		RETURN	Always true

From EMBOSS 6.0.0

Function ajFeatoutPrintFormat

Reports the internal data structures for output feature formats

Prototype

void ajFeatoutPrintFormat (
      AjPFile outf,
      AjBool full
);

Type Name Read/Write Description

AjPFile outf Modify Output file

AjBool full Input Full report (usually ajFalse)

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`AjBool`	`full`	Input	Full report (usually ajFalse)
`void`		RETURN

From EMBOSS 6.4.0

Function ajFeatoutPrinthtmlFormat

Reports the internal data structures for output feature formats

Prototype

void ajFeatoutPrinthtmlFormat (
      AjPFile outf
);

Type Name Read/Write Description

AjPFile outf Modify Output file

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`void`		RETURN

From EMBOSS 6.4.0

Function ajFeatoutPrintbookFormat

Reports the output feature format internals in docbook format

Prototype

void ajFeatoutPrintbookFormat (
      AjPFile outf
);

Type Name Read/Write Description

AjPFile outf Modify Output file

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`void`		RETURN

From EMBOSS 6.2.0

Function ajFeatoutPrintwikiFormat

Reports the output feature format internals in wiki text format

Prototype

void ajFeatoutPrintwikiFormat (
      AjPFile outf
);

Type Name Read/Write Description

AjPFile outf Modify Output file

void RETURN

Type	Name	Read/Write	Description
`AjPFile`	`outf`	Modify	Output file
`void`		RETURN

From EMBOSS 6.2.0

Function ajFeatwriteExit

Cleans up feature table output internal memory

Prototype

void ajFeatwriteExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.4.0