ajresource.c

Datatypes:

AjPResource Data resource data

AjPReslink Data resource link data

AjPList Resource link list operations

AjPResquery Data resource query data

AjPList Resource query list operations

AjPResterm Data resource term data

AjPList Resource term list operations

none Miscellaneous functions

Datatype: AjPResource

Function is for manipulating data resource data objects

Sections:

constructors Constructors

Data resource data destructors Destructors

Casts Casts

data resource data modifiers Modifiers

casts Casts

AjPResource: constructors

Constructors

Functions:

ajResourceNew Resource data constructor

ajResourceNewDrcat Resource data constructor for an entry in DRCAT

ajResourceNewResource Copy constructor for a public resource object

Function ajResourceNew

Resource data constructor

Prototype

AjPResource ajResourceNew (
      void
);

Type Name Read/Write Description

AjPResource RETURN New object

Type	Name	Read/Write	Description
`AjPResource`		RETURN	New object

From EMBOSS 6.4.0

Function ajResourceNewDrcat

Resource data constructor for an entry in DRCAT

Prototype

AjPResource ajResourceNewDrcat (
      const AjPStr dbname
);

Type Name Read/Write Description

const AjPStr dbname Input DRCAT identifier

AjPResource RETURN New object

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	DRCAT identifier
`AjPResource`		RETURN	New object

From EMBOSS 6.4.0

Function ajResourceNewResource

Copy constructor for a public resource object

Prototype

AjPResource ajResourceNewResource (
      const AjPResource res
);

Type Name Read/Write Description

const AjPResource res Input Resource object

AjPResource RETURN Resource object

Type	Name	Read/Write	Description
`const AjPResource`	`res`	Input	Resource object
`AjPResource`		RETURN	Resource object

From EMBOSS 6.4.0

AjPResource: Data resource data destructors

Destruction destroys all internal data structures and frees the memory allocated for the data resource data object.

Functions:

ajResourceDel Data resource data destructor

Function ajResourceDel

Data resource data destructor

Prototype

void ajResourceDel (
      AjPResource* Presource
);

Type Name Read/Write Description

AjPResource* Presource Delete Data resource data object to delete

void RETURN

Type	Name	Read/Write	Description
`AjPResource*`	`Presource`	Delete	Data resource data object to delete
`void`		RETURN

From EMBOSS 6.4.0

AjPResource: Casts

Return values from a data resource data object

Functions:

ajResourceGetDbdata Returns a query database definition using a data resource data object.

ajResourceGetEntry Return the complete text

ajResourceGetId Return the identifier

ajResourceGetQryC Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

ajResourceGetQryS Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Function ajResourceGetDbdata

Returns a query database definition using a data resource data object.

Prototype

AjBool ajResourceGetDbdata (
      const AjPResource resource,
      AjPQuery qry,
      AjBool function findformat
);

Type Name Read/Write Description

const AjPResource resource Input Data resource data object.

AjPQuery qry Output Query object.

AjBool function findformat Function Find format function for datatype

AjBool RETURN True on success

Type	Name	Read/Write	Description
`const AjPResource`	`resource`	Input	Data resource data object.
`AjPQuery`	`qry`	Output	Query object.
`AjBool function`	`findformat`	Function	Find format function for datatype
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Function ajResourceGetEntry

Return the complete text

Prototype

const AjPStr ajResourceGetEntry (
      const AjPResource resource
);

Type Name Read/Write Description

const AjPResource resource Input Data resource

const AjPStr RETURN Returned entry text

Type	Name	Read/Write	Description
`const AjPResource`	`resource`	Input	Data resource
`const AjPStr`		RETURN	Returned entry text

From EMBOSS 6.4.0

Function ajResourceGetId

Return the identifier

Prototype

const AjPStr ajResourceGetId (
      const AjPResource resource
);

Type Name Read/Write Description

const AjPResource resource Input Data resource

const AjPStr RETURN Returned id

Type	Name	Read/Write	Description
`const AjPResource`	`resource`	Input	Data resource
`const AjPStr`		RETURN	Returned id

From EMBOSS 6.4.0

Function ajResourceGetQryC

Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

Prototype

const char* ajResourceGetQryC (
      const AjPResource resource
);

Type Name Read/Write Description

const AjPResource resource Input Data resource data object.

const char* RETURN Query as a character string.

Type	Name	Read/Write	Description
`const AjPResource`	`resource`	Input	Data resource data object.
`const char*`		RETURN	Query as a character string.

From EMBOSS 6.4.0

Function ajResourceGetQryS

Prototype

const AjPStr ajResourceGetQryS (
      const AjPResource resource
);

Type Name Read/Write Description

const AjPResource resource Input Data resource data object.

const AjPStr RETURN Query as a string.

Type	Name	Read/Write	Description
`const AjPResource`	`resource`	Input	Data resource data object.
`const AjPStr`		RETURN	Query as a string.

From EMBOSS 6.4.0

AjPResource: data resource data modifiers

Data resource data modifiers

Functions:

ajResourceClear Resets all data for a data resource data object so that it can be reused.

Function ajResourceClear

Resets all data for a data resource data object so that it can be reused.

Prototype

void ajResourceClear (
      AjPResource resource
);

Type Name Read/Write Description

AjPResource resource Modify Data resource data object

void RETURN

Type	Name	Read/Write	Description
`AjPResource`	`resource`	Modify	Data resource data object
`void`		RETURN

From EMBOSS 6.4.0

AjPResource: casts

Return values

Functions:

ajResourceTrace Write debug report of a resource object

Function ajResourceTrace

Write debug report of a resource object

Prototype

void ajResourceTrace (
      const AjPResource thys
);

Type Name Read/Write Description

const AjPResource thys Input Resource object

void RETURN

Type	Name	Read/Write	Description
`const AjPResource`	`thys`	Input	Resource object
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPReslink

Function is for manipulating data resource link data objects

Sections:

constructors Constructors

Data resource link data destructors Destructors

AjPReslink: constructors

Constructors

Functions:

ajReslinkNew Constructor for a public resource link object

ajReslinkNewReslink Constructor for a public resource link object

Function ajReslinkNew

Constructor for a public resource link object

Prototype

AjPReslink ajReslinkNew (
      void
);

Type Name Read/Write Description

AjPReslink RETURN Resource link object

Type	Name	Read/Write	Description
`AjPReslink`		RETURN	Resource link object

From EMBOSS 6.4.0

Function ajReslinkNewReslink

Constructor for a public resource link object

Prototype

AjPReslink ajReslinkNewReslink (
      const AjPReslink reslink
);

Type Name Read/Write Description

const AjPReslink reslink Input Source resource link object

AjPReslink RETURN Resource link object

Type	Name	Read/Write	Description
`const AjPReslink`	`reslink`	Input	Source resource link object
`AjPReslink`		RETURN	Resource link object

From EMBOSS 6.4.0

AjPReslink: Data resource link data destructors

Destruction destroys all internal data structures and frees the memory allocated for the data resource link data object.

Functions:

ajReslinkDel Destructor for a public resource link object

Function ajReslinkDel

Destructor for a public resource link object

Prototype

void ajReslinkDel (
      AjPReslink* Preslink
);

Type Name Read/Write Description

AjPReslink* Preslink Delete Resource link object

void RETURN

Type	Name	Read/Write	Description
`AjPReslink*`	`Preslink`	Delete	Resource link object
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPList

Manipulating lists of resource links

Sections:

Resource link list operations General use

AjPList: Resource link list operations

Manipulating lists of resource links

Functions:

ajReslinklistClone Copy a list of resource links to another list

Function ajReslinklistClone

Copy a list of resource links to another list

Prototype

AjBool ajReslinklistClone (
      const AjPList src,
      AjPList dest
);

Type Name Read/Write Description

const AjPList src Input Source list of resource links

AjPList dest Output Destination list of resource links

AjBool RETURN True on success

Type	Name	Read/Write	Description
`const AjPList`	`src`	Input	Source list of resource links
`AjPList`	`dest`	Output	Destination list of resource links
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Datatype: AjPResquery

Function is for manipulating data resource query data objects

Sections:

constructors Constructors

Data resource query data destructors Destructors

AjPResquery: constructors

Constructors

Functions:

ajResqueryNew Constructor for a public resource query object

ajResqueryNewResquery Constructor for a public resource query object

Function ajResqueryNew

Constructor for a public resource query object

Prototype

AjPResquery ajResqueryNew (
      void
);

Type Name Read/Write Description

AjPResquery RETURN Resource query object

Type	Name	Read/Write	Description
`AjPResquery`		RETURN	Resource query object

From EMBOSS 6.4.0

Function ajResqueryNewResquery

Constructor for a public resource query object

Prototype

AjPResquery ajResqueryNewResquery (
      const AjPResquery qry
);

Type Name Read/Write Description

const AjPResquery qry Input Source resource query object

AjPResquery RETURN Resource query object

Type	Name	Read/Write	Description
`const AjPResquery`	`qry`	Input	Source resource query object
`AjPResquery`		RETURN	Resource query object

From EMBOSS 6.4.0

AjPResquery: Data resource query data destructors

Destruction destroys all internal data structures and frees the memory allocated for the data resource query data object.

Functions:

ajResqueryDel Destructor for a public resource query object

Function ajResqueryDel

Destructor for a public resource query object

Prototype

void ajResqueryDel (
      AjPResquery* Presquery
);

Type Name Read/Write Description

AjPResquery* Presquery Delete Resource query object

void RETURN

Type	Name	Read/Write	Description
`AjPResquery*`	`Presquery`	Delete	Resource query object
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPList

Manipulating lists of resource queries

Sections:

Resource query list operations General use

AjPList: Resource query list operations

Manipulating lists of resource queries

Functions:

ajResquerylistClone Copy a list of resource queries to another list

Function ajResquerylistClone

Copy a list of resource queries to another list

Prototype

AjBool ajResquerylistClone (
      const AjPList src,
      AjPList dest
);

Type Name Read/Write Description

const AjPList src Input Source list of resource queries

AjPList dest Output Destination list of resource queries

AjBool RETURN True on success

Type	Name	Read/Write	Description
`const AjPList`	`src`	Input	Source list of resource queries
`AjPList`	`dest`	Output	Destination list of resource queries
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Datatype: AjPResterm

Function is for manipulating data resource term data objects

Sections:

constructors Constructors

Data resource term data destructors Destructors

AjPResterm: constructors

Constructors

Functions:

ajRestermNew Constructor for a public resource term object

ajRestermNewResterm Constructor for a public resource term object

Function ajRestermNew

Constructor for a public resource term object

Prototype

AjPResterm ajRestermNew (
      void
);

Type Name Read/Write Description

AjPResterm RETURN Resource term object

Type	Name	Read/Write	Description
`AjPResterm`		RETURN	Resource term object

From EMBOSS 6.4.0

Function ajRestermNewResterm

Constructor for a public resource term object

Prototype

AjPResterm ajRestermNewResterm (
      const AjPResterm term
);

Type Name Read/Write Description

const AjPResterm term Input Source resource term object

AjPResterm RETURN Resource term object

Type	Name	Read/Write	Description
`const AjPResterm`	`term`	Input	Source resource term object
`AjPResterm`		RETURN	Resource term object

From EMBOSS 6.4.0

AjPResterm: Data resource term data destructors

Destruction destroys all internal data structures and frees the memory allocated for the data resource term data object.

Functions:

ajRestermDel Destructor for a public resource term object

Function ajRestermDel

Destructor for a public resource term object

Prototype

void ajRestermDel (
      AjPResterm* Presterm
);

Type Name Read/Write Description

AjPResterm* Presterm Delete Resource term object

void RETURN

Type	Name	Read/Write	Description
`AjPResterm*`	`Presterm`	Delete	Resource term object
`void`		RETURN

From EMBOSS 6.4.0

Datatype: AjPList

Manipulating lists of resource terms

Sections:

Resource term list operations General use

AjPList: Resource term list operations

Manipulating lists of resource terms

Functions:

ajRestermlistClone Copy a list of resource terms to another list

Function ajRestermlistClone

Copy a list of resource terms to another list

Prototype

AjBool ajRestermlistClone (
      const AjPList src,
      AjPList dest
);

Type Name Read/Write Description

const AjPList src Input Source list of resource terms

AjPList dest Output Destination list of resource terms

AjBool RETURN True on success

Type	Name	Read/Write	Description
`const AjPList`	`src`	Input	Source list of resource terms
`AjPList`	`dest`	Output	Destination list of resource terms
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Prototype

void ajResourceExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 6.4.0

AjPResource	Data resource data
AjPReslink	Data resource link data
AjPList	Resource link list operations
AjPResquery	Data resource query data
AjPList	Resource query list operations
AjPResterm	Data resource term data
AjPList	Resource term list operations
none	Miscellaneous functions

constructors	Constructors
Data resource data destructors	Destructors
Casts	Casts
data resource data modifiers	Modifiers
casts	Casts

ajResourceNew	Resource data constructor
ajResourceNewDrcat	Resource data constructor for an entry in DRCAT
ajResourceNewResource	Copy constructor for a public resource object

ajResourceGetDbdata	Returns a query database definition using a data resource data object.
ajResourceGetEntry	Return the complete text
ajResourceGetId	Return the identifier
ajResourceGetQryC	Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.
ajResourceGetQryS	Returns the query string of a data resource data object. Because this is a pointer to the real internal string the caller must take care not to change the character string in any way. If the string is to be changed (case for example) then it must first be copied.

constructors	Constructors
Data resource link data destructors	Destructors

ajReslinkNew	Constructor for a public resource link object
ajReslinkNewReslink	Constructor for a public resource link object

constructors	Constructors
Data resource query data destructors	Destructors

ajResqueryNew	Constructor for a public resource query object
ajResqueryNewResquery	Constructor for a public resource query object

constructors	Constructors
Data resource term data destructors	Destructors

ajRestermNew	Constructor for a public resource term object
ajRestermNewResterm	Constructor for a public resource term object