Datatypes:
AjPTextin | Text input objects |
none | Miscellaneous |
AjPTable | Internal call register table |
AjPTextall | Text Input Stream |
none | Input formats |
Sections:
Text Input Constructors | Constructors |
Text Input Destructors | Destructors |
text input modifiers | Modifiers |
store | Casts |
casts | Casts |
Text data inputs | Input |
File Access | Input |
Functions:
ajTextinNew | Creates a new text input object. |
ajTextinNewDatatype | Creates a new text input object for assembly data |
AjPTextin ajTextinNew ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | RETURN | New text input object. |
From EMBOSS 6.4.0
AjPTextin ajTextinNewDatatype ( const AjEDataType datatype );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjEDataType | datatype | Input | Enumerated datatype |
AjPTextin | RETURN | New text input object. |
From EMBOSS 6.4.0
Functions:
ajTextinDel | Deletes a text input object. |
ajTextinDelNofile | Deletes a text input object but do not close the file as it is a copy of a file buffer elsewhere |
void ajTextinDel ( AjPTextin* pthis );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin* | pthis | Delete | Text input |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinDelNofile ( AjPTextin* pthis );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin* | pthis | Delete | Text input |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextinClear | Clears a text input object back to "as new" condition, except for the query list which must be preserved. |
ajTextinClearNewfile | Clears a text input object statistics for continued input with a new file |
ajTextinClearNewinput | Clears a text input object statistics for continued input with same file |
ajTextinClearNofile | Clears a text input object back to "as new" condition, except for the query list which must be preserved. |
ajTextinQryC | Resets a text input object using a new Universal Query Address |
ajTextinQryS | Resets a text input object using a new Universal Query Address |
void ajTextinClear ( AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Output | Text input |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinClearNewfile ( AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Output | Text input |
void | RETURN |
From EMBOSS 6.6.0
void ajTextinClearNewinput ( AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Output | Text input |
void | RETURN |
From EMBOSS 6.6.0
void ajTextinClearNofile ( AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Output | Text input |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinQryC ( AjPTextin thys, const char* txt );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Modify | text input object. |
const char* | txt | Input | Query |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinQryS ( AjPTextin thys, const AjPStr str );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Modify | Text input object. |
const AjPStr | str | Input | Query |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextinStoreClear | Clear the latest record from a text input buffer and any saved buffered text |
ajTextinStoreReadline | Read the next line of input and if required store in buffer |
ajTextinStoreReset | Reset a text input object buffer and any saved buffered text |
void ajTextinStoreClear ( AjPTextin thys, ajint lines, const AjPStr rdline, AjPStr* astr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Modify | Text input object |
ajint | lines | Input | Number of lines to keep |
const AjPStr | rdline | Input | Last input record to trim |
AjPStr* | astr | Modify | Current text buffer |
void | RETURN |
In release 6.5.0
AjBool ajTextinStoreReadline ( AjPTextin thys, AjPStr* pdest, AjPStr* astr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Modify | Text input object |
AjPStr* | pdest | Output | Next input record |
AjPStr* | astr | Modify | Current text buffer |
AjBool | RETURN | True on success |
In release 6.5.0
void ajTextinStoreReset ( AjPTextin thys, AjPStr* astr );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | thys | Modify | Text input object |
AjPStr* | astr | Modify | Current text buffer |
void | RETURN |
In release 6.5.0
Functions:
ajTextinGetCount | Returns the input count of a text input object |
ajTextinGetFpos | Returns the file position of a text input object |
ajTextinGetQryS | Returns the query of a text input object |
ajTextinGetRecords | Returns the record count of a text input object |
ajTextinGetTotrecords | Returns the total record count of a text input object |
ajTextinTrace | Debug calls to trace the data in a text input object. |
ajuint ajTextinGetCount ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
ajuint | RETURN | Input count |
From EMBOSS 6.6.0
ajlong ajTextinGetFpos ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
ajlong | RETURN | File position |
From EMBOSS 6.6.0
const AjPStr ajTextinGetQryS ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
const AjPStr | RETURN | Query string |
From EMBOSS 6.4.0
ajuint ajTextinGetRecords ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
ajuint | RETURN | Record count |
From EMBOSS 6.6.0
ajuint ajTextinGetTotrecords ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
ajuint | RETURN | Total record count |
From EMBOSS 6.6.0
void ajTextinTrace ( const AjPTextin thys );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPTextin | thys | Input | Text input object. |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextinRead | If the file is not yet open, calls textinQryProcess to convert the query into an open file stream. |
AjBool ajTextinRead ( AjPTextin textin, AjPText text );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | text data input definitions |
AjPText | text | Output | text data returned. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
Functions:
ajTextinAccessAsis | Reads text using the 'filename' as the single input line |
ajTextinAccessFile | Reads data from a named file. |
ajTextinAccessFtp | Reads data from an FTP URL |
ajTextinAccessHttp | Reads data from an HTTP URL. No HTML is stripped. |
ajTextinAccessOffset | Reads a text from a named file, at a given offset within the file. |
AjBool ajTextinAccessAsis ( AjPTextin textin );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | Text input. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
AjBool ajTextinAccessFile ( AjPTextin textin );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | Text input. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
AjBool ajTextinAccessFtp ( AjPTextin textin );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | Text input. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.5.0
AjBool ajTextinAccessHttp ( AjPTextin textin );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | Text input. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.5.0
AjBool ajTextinAccessOffset ( AjPTextin textin );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextin | textin | Modify | Text input. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
Sections:
Casts |
Functions:
ajTextinprintBook | Reports the internal data structures as a Docbook table |
ajTextinprintHtml | Reports the internal data structures as an HTML table |
ajTextinprintText | Reports the internal data structures |
ajTextinprintWiki | Reports the internal data structures as a wiki table |
void ajTextinprintBook ( AjPFile outf );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPFile | outf | Modify | Output file |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinprintHtml ( AjPFile outf );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPFile | outf | Modify | Output file |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinprintText ( AjPFile outf, AjBool full );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPFile | outf | Modify | Output file |
AjBool | full | Input | Full report (usually ajFalse) |
void | RETURN |
From EMBOSS 6.4.0
void ajTextinprintWiki ( AjPFile outf );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPFile | outf | Modify | Output file |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextinExit | Cleans up text data input internal memory |
void ajTextinExit ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextinTypeGetFields | Returns the listof known field names for ajTextinRead |
ajTextinTypeGetQlinks | Returns the listof known query link operators for ajTextinRead |
const char* ajTextinTypeGetFields ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
const char* | RETURN | List of field names |
From EMBOSS 6.4.0
const char* ajTextinTypeGetQlinks ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
const char* | RETURN | List of field names |
From EMBOSS 6.4.0
Sections:
Cast | Casts |
Functions:
ajTextaccessGetDb | Returns the table in which text database access details are registered |
ajTextaccessMethodGetQlinks | Tests for a named method for text file reading and returns the known query link operators |
ajTextaccessMethodGetScope | Tests for a named method for text file reading and returns the scope (entry, query or all). |
ajTextaccessMethodTest | Tests for a named method for text reading. |
AjPTable ajTextaccessGetDb ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTable | RETURN | Access functions hash table |
From EMBOSS 6.4.0
const char* ajTextaccessMethodGetQlinks ( const AjPStr method );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPStr | method | Input | Method required. |
const char* | RETURN | Known link operators |
From EMBOSS 6.4.0
ajuint ajTextaccessMethodGetScope ( const AjPStr method );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPStr | method | Input | Method required. |
ajuint | RETURN | Scope flags |
From EMBOSS 6.4.0
AjBool ajTextaccessMethodTest ( const AjPStr method );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPStr | method | Input | Method required. |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
Sections:
Text Input Constructors | Constructors |
Text Input Stream Destructors | Destructors |
Text input stream modifiers | Modifiers |
Text input | Input |
Functions:
ajTextallNew | Creates a new text input stream object. |
AjPTextall ajTextallNew ( void );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextall | RETURN | New text input stream object. |
From EMBOSS 6.4.0
Functions:
ajTextallDel | Deletes a text input stream object. |
void ajTextallDel ( AjPTextall* pthis );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextall* | pthis | Delete | Text input stream |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextallClear | Clears a text input stream object back to "as new" condition, except for the query list which must be preserved. |
void ajTextallClear ( AjPTextall thys );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextall | thys | Output | Text input stream |
void | RETURN |
From EMBOSS 6.4.0
Functions:
ajTextallNext | Parse a text query into format, access, file and entry |
AjBool ajTextallNext ( AjPTextall thys, AjPText* Ptext );
Type | Name | Read/Write | Description |
---|---|---|---|
AjPTextall | thys | Output | Text input stream |
AjPText* | Ptext | Modify | Text block returned |
AjBool | RETURN | ajTrue on success. |
From EMBOSS 6.4.0
Sections:
cast | Casts |
Functions:
ajTextinformatTerm | tests whether a text input format term is known |
ajTextinformatTest | tests whether a named text input format is known |
AjBool ajTextinformatTerm ( const AjPStr term );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPStr | term | Input | Format term EDAM ID |
AjBool | RETURN | ajTrue if term was accepted |
From EMBOSS 6.4.0
AjBool ajTextinformatTest ( const AjPStr format );
Type | Name | Read/Write | Description |
---|---|---|---|
const AjPStr | format | Input | Format |
AjBool | RETURN | ajTrue if format was accepted |
From EMBOSS 6.4.0