ajpdb.c

Section: Constructors

All constructors return a pointer to a new instance. It is the responsibility of the user to first destroy any previous instance. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions: ajPdbtospReadAllRawNew ajPdbtospReadNew ajPdbtospReadCNew ajPdbtospReadAllNew ajCmapReadINew ajCmapReadCNew ajCmapReadAllNew ajCmapReadNew ajVdwallReadNew ajHetReadNew ajHetReadRawNew ajPdbReadFirstModelNew ajPdbReadAllModelsNew ajPdbReadNew ajPdbReadoldNew ajPdbReadoldFirstModelNew ajAtomNew ajResidueNew ajChainNew ajPdbNew ajHetentNew ajHetNew ajVdwallNew ajVdwresNew ajCmapNew ajPdbtospNew

Function ajPdbtospReadAllRawNew

Reads the swissprot:pdb equivalence table available at URL (1) (1) http://www.expasy.ch/cgi-bin/lists?pdbtosp.txt and returns the data as a list of Pdbtosp objects.

Synopsis

Prototype
AjPList ajPdbtospReadAllRawNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file
AjPList RETURNList of Pdbtosp objects.

Input & Output
inf:(Modify)Input file
Returns
AjPList:List of Pdbtosp objects.

Description

Reads the swissprot:pdb equivalence table available at URL (1) (1) http://www.expasy.ch/cgi-bin/lists?pdbtosp.txt and returns the data as a list of Pdbtosp objects.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospReadNew

Read a Pdbtosp object from a file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application).

Synopsis

Prototype
AjPPdbtosp ajPdbtospReadNew (
      AjPFile inf,
      const AjPStr entry
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
const AjPStrentryInputPdb id
AjPPdbtosp RETURNTrue on success

Input
entry:(Input)Pdb id
Input & Output
inf:(Modify)Input file stream
Returns
AjPPdbtosp:True on success

Description

Read a Pdbtosp object from a file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospReadCNew

Read a Pdbtosp object from a file in embl-like format. Memory for the object is allocated.

Synopsis

Prototype
AjPPdbtosp ajPdbtospReadCNew (
      AjPFile inf,
      const char* entry
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
const char*entryInputPdb id
AjPPdbtosp RETURNTrue on success

Input
entry:(Input)Pdb id
Input & Output
inf:(Modify)Input file stream
Returns
AjPPdbtosp:True on success

Description

Read a Pdbtosp object from a file in embl-like format. Memory for the object is allocated.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospReadAllNew

Read all the Pdbtosp objects in a file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application) and writes a list of these objects. It then sorts the list by PDB id.

Synopsis

Prototype
AjPList ajPdbtospReadAllNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
AjPList RETURNList of Pdbtosp objects.

Input & Output
inf:(Modify)Input file stream
Returns
AjPList:List of Pdbtosp objects.

Description

Read all the Pdbtosp objects in a file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application) and writes a list of these objects. It then sorts the list by PDB id.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapReadINew

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). Takes the chain identifier as an integer. If the arguments mod and chn are both 0, the function will read the next Cmap in the file.

Synopsis

Prototype
AjPCmap ajCmapReadINew (
      AjPFile inf,
      ajint chn,
      ajint mod
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
ajintchnInputChain number
ajintmodInputModel number
AjPCmap RETURNPointer to new Cmap object.

Input
chn:(Input)Chain number
mod:(Input)Model number
Input & Output
inf:(Modify)Input file stream
Returns
AjPCmap:Pointer to new Cmap object.

Description

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). Takes the chain identifier as an integer. If the arguments mod and chn are both 0, the function will read the next Cmap in the file.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapReadCNew

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). Takes the chain identifier as a character.

Synopsis

Prototype
AjPCmap ajCmapReadCNew (
      AjPFile inf,
      char chn,
      ajint mod
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
charchnInputChain number
ajintmodInputModel number
AjPCmap RETURNPointer to new Cmap object.

Input
chn:(Input)Chain number
mod:(Input)Model number
Input & Output
inf:(Modify)Input file stream
Returns
AjPCmap:Pointer to new Cmap object.

Description

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). Takes the chain identifier as a character.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapReadAllNew

Read every Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application) and returns a list of these objects.

Synopsis

Prototype
AjPList ajCmapReadAllNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
AjPList RETURNList of Cmap objects.

Input & Output
inf:(Modify)Input file stream
Returns
AjPList:List of Cmap objects.

Description

Read every Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application) and returns a list of these objects.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapReadNew

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). This is not usually called by the user, who uses ajCmapReadINew or ajCmapReadCNew instead. If mode==CMAP_MODE_I, chn==0 and mod==0, the function will read the next Cmap in the file.

Synopsis

Prototype
AjPCmap ajCmapReadNew (
      AjPFile inf,
      ajint mode,
      ajint chn,
      ajint mod
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream.
ajintmodeInputMode, either CMAP_MODE_I (treat chn arg as an integer) or CMAP_MODE_C (treat chn arg as a character).
ajintchnInputChain identifier / number.
ajintmodInputModel number.
AjPCmap RETURNTrue on success (an object read)

Input
mode:(Input)Mode, either CMAP_MODE_I (treat chn arg as an integer) or CMAP_MODE_C (treat chn arg as a character).
chn:(Input)Chain identifier / number.
mod:(Input)Model number.
Input & Output
inf:(Modify)Input file stream.
Returns
AjPCmap:True on success (an object read)

Description

Read a Cmap object from a file in CON format (see documentation for DOMAINATRIX "contacts" application). This is not usually called by the user, who uses ajCmapReadINew or ajCmapReadCNew instead. If mode==CMAP_MODE_I, chn==0 and mod==0, the function will read the next Cmap in the file.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVdwallReadNew

Read a Vdwall object from a file in embl-like format (see documentation for the EMBASSY DOMAINATRIX package).

Synopsis

Prototype
AjPVdwall ajVdwallReadNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyInput file stream
AjPVdwall RETURNPointer to Vdwall object.

Input & Output
inf:(Modify)Input file stream
Returns
AjPVdwall:Pointer to Vdwall object.

Description

Read a Vdwall object from a file in embl-like format (see documentation for the EMBASSY DOMAINATRIX package).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetReadNew

Read heterogen dictionary, the Het object is allocated.

Synopsis

Prototype
AjPHet ajHetReadNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to Het file
AjPHet RETURNHet object.

Input & Output
inf:(Modify)Pointer to Het file
Returns
AjPHet:Het object.

Description

Read heterogen dictionary, the Het object is allocated.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetReadRawNew

Reads a dictionary of heterogen groups available at http://pdb.rutgers.edu/het_dictionary.txt and writes a Het object.

Synopsis

Prototype
AjPHet ajHetReadRawNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to dictionary
AjPHet RETURNTrue on success

Input & Output
inf:(Modify)Pointer to dictionary
Returns
AjPHet:True on success

Description

Reads a dictionary of heterogen groups available at http://pdb.rutgers.edu/het_dictionary.txt and writes a Het object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbReadFirstModelNew

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for the first model only is read in.

Synopsis

Prototype
AjPPdb ajPdbReadFirstModelNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to clean coordinate file
AjPPdb RETURNPointer to Pdb object.

Input & Output
inf:(Modify)Pointer to clean coordinate file
Returns
AjPPdb:Pointer to Pdb object.

Description

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for the first model only is read in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbReadAllModelsNew

Reads a clean coordinate file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for all models is read.

Synopsis

Prototype
AjPPdb ajPdbReadAllModelsNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to clean coordinate file
AjPPdb RETURNPointer to Pdb object.

Input & Output
inf:(Modify)Pointer to clean coordinate file
Returns
AjPPdb:Pointer to Pdb object.

Description

Reads a clean coordinate file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for all models is read.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbReadNew

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for the first model only is read in.

Synopsis

Prototype
AjPPdb ajPdbReadNew (
      AjPFile inf,
      ajint mode
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to clean coordinate file
ajintmodeInputMode. 0==Read first model only. 1==Read all models.
AjPPdb RETURNPointer to Pdb object.

Input
mode:(Input)Mode. 0==Read first model only. 1==Read all models.
Input & Output
inf:(Modify)Pointer to clean coordinate file
Returns
AjPPdb:Pointer to Pdb object.

Description

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) and writes a filled Pdb object. Data for the first model only is read in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbReadoldNew

Reads a clean coordinate file (see documentation for DOMAINATRIX "pdbparse" application) lacking residue-level description in RE records and writes a filled Pdb object.

Synopsis

Prototype
AjPPdb ajPdbReadoldNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to clean coordinate file
AjPPdb RETURNPointer to Pdb object.

Input & Output
inf:(Modify)Pointer to clean coordinate file
Returns
AjPPdb:Pointer to Pdb object.

Description

Reads a clean coordinate file (see documentation for DOMAINATRIX "pdbparse" application) lacking residue-level description in RE records and writes a filled Pdb object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbReadoldFirstModelNew

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) lacking residue-level description in RE records and writes a filled Pdb object. Data for the first model only is read in.

Synopsis

Prototype
AjPPdb ajPdbReadoldFirstModelNew (
      AjPFile inf
);

TypeNameRead/WriteDescription
AjPFileinfModifyPointer to clean coordinate file
AjPPdb RETURNPointer to Pdb object.

Input & Output
inf:(Modify)Pointer to clean coordinate file
Returns
AjPPdb:Pointer to Pdb object.

Description

Reads a clean coordinate file file (see documentation for DOMAINATRIX "pdbparse" application) lacking residue-level description in RE records and writes a filled Pdb object. Data for the first model only is read in.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAtomNew

Atom object constructor. This is normally called by the ajChainNew function.

Synopsis

Prototype
AjPAtom ajAtomNew (
      void
);

TypeNameRead/WriteDescription
AjPAtom RETURNPointer to an atom object

Returns
AjPAtom:Pointer to an atom object

Description

Atom object constructor. This is normally called by the ajChainNew function.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueNew

Residue object constructor. This is normally called by the ajChainNew function.

Synopsis

Prototype
AjPResidue ajResidueNew (
      void
);

TypeNameRead/WriteDescription
AjPResidue RETURNPointer to a Residue object

Returns
AjPResidue:Pointer to a Residue object

Description

Residue object constructor. This is normally called by the ajChainNew function.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajChainNew

Chain object constructor. This is normally called by the ajPdbNew function

Synopsis

Prototype
AjPChain ajChainNew (
      void
);

TypeNameRead/WriteDescription
AjPChain RETURNPointer to a chain object

Returns
AjPChain:Pointer to a chain object

Description

Chain object constructor. This is normally called by the ajPdbNew function

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbNew

Pdb object constructor. Fore-knowledge of the number of chains is required. This is normally called by the functions that read PDB files or clean coordinate files (see embpdb.c & embpdbraw.c).

Synopsis

Prototype
AjPPdb ajPdbNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of chains in this pdb file
AjPPdb RETURNPointer to a pdb object

Input
n:(Input)Number of chains in this pdb file
Returns
AjPPdb:Pointer to a pdb object

Description

Pdb object constructor. Fore-knowledge of the number of chains is required. This is normally called by the functions that read PDB files or clean coordinate files (see embpdb.c & embpdbraw.c).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetentNew

Hetent object constructor.

Synopsis

Prototype
AjPHetent ajHetentNew (
      void
);

TypeNameRead/WriteDescription
AjPHetent RETURNPointer to a Hetent object

Returns
AjPHetent:Pointer to a Hetent object

Description

Hetent object constructor.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetNew

Het object constructor.

Synopsis

Prototype
AjPHet ajHetNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of entries in dictionary.
AjPHet RETURNPointer to a Het object

Input
n:(Input)Number of entries in dictionary.
Returns
AjPHet:Pointer to a Het object

Description

Het object constructor.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVdwallNew

Vdwall object constructor. This is normally called by the ajVdwallReadNew function. Fore-knowledge of the number of residues is required.

Synopsis

Prototype
AjPVdwall ajVdwallNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of residues
AjPVdwall RETURNPointer to a Vdwall object

Input
n:(Input)Number of residues
Returns
AjPVdwall:Pointer to a Vdwall object

Description

Vdwall object constructor. This is normally called by the ajVdwallReadNew function. Fore-knowledge of the number of residues is required.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVdwresNew

Vdwres object constructor. This is normally called by the ajVdwallReadNew function. Fore-knowledge of the number of atoms is required.

Synopsis

Prototype
AjPVdwres ajVdwresNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of atoms
AjPVdwres RETURNPointer to a Vdwres object

Input
n:(Input)Number of atoms
Returns
AjPVdwres:Pointer to a Vdwres object

Description

Vdwres object constructor. This is normally called by the ajVdwallReadNew function. Fore-knowledge of the number of atoms is required.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapNew

Cmap object constructor. This is normally called by the ajCmapReadNew function. Fore-knowledge of the dimension (number of residues) for the contact map is required.

Synopsis

Prototype
AjPCmap ajCmapNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputDimension of contact map
AjPCmap RETURNPointer to a Cmap object

Input
n:(Input)Dimension of contact map
Returns
AjPCmap:Pointer to a Cmap object

Description

Cmap object constructor. This is normally called by the ajCmapReadNew function. Fore-knowledge of the dimension (number of residues) for the contact map is required.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospNew

Pdbtosp object constructor. Fore-knowledge of the number of entries is required. This is normally called by the ajPdbtospReadCNew / ajPdbtospReadNew functions.

Synopsis

Prototype
AjPPdbtosp ajPdbtospNew (
      ajint n
);

TypeNameRead/WriteDescription
ajintnInputNumber of entries
AjPPdbtosp RETURNPointer to a Pdbtosp object

Input
n:(Input)Number of entries
Returns
AjPPdbtosp:Pointer to a Pdbtosp object

Description

Pdbtosp object constructor. Fore-knowledge of the number of entries is required. This is normally called by the ajPdbtospReadCNew / ajPdbtospReadNew functions.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Destructors

All destructor functions receive the address of the instance to be deleted. The original pointer is set to NULL so is ready for re-use.

Functions: ajAtomDel ajResidueDel ajChainDel ajPdbDel ajHetentDel ajHetDel ajVdwallDel ajVdwresDel ajCmapDel ajPdbtospDel

Function ajAtomDel

Destructor for atom object.

Synopsis

Prototype
void ajAtomDel (
      AjPAtom* ptr
);

TypeNameRead/WriteDescription
AjPAtom*ptrDeleteAtom object pointer
void RETURN

Output
ptr:(Delete)Atom object pointer
Returns
void:No return value

Description

Destructor for atom object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueDel

Destructor for residue object.

Synopsis

Prototype
void ajResidueDel (
      AjPResidue* ptr
);

TypeNameRead/WriteDescription
AjPResidue*ptrDeleteResidue object pointer
void RETURN

Output
ptr:(Delete)Residue object pointer
Returns
void:No return value

Description

Destructor for residue object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajChainDel

Destructor for chain object.

Synopsis

Prototype
void ajChainDel (
      AjPChain* ptr
);

TypeNameRead/WriteDescription
AjPChain*ptrDeleteChain object pointer
void RETURN

Output
ptr:(Delete)Chain object pointer
Returns
void:No return value

Description

Destructor for chain object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbDel

Destructor for pdb object.

Synopsis

Prototype
void ajPdbDel (
      AjPPdb* ptr
);

TypeNameRead/WriteDescription
AjPPdb*ptrDeletePdb object pointer
void RETURN

Output
ptr:(Delete)Pdb object pointer
Returns
void:No return value

Description

Destructor for pdb object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetentDel

Destructor for Hetent object.

Synopsis

Prototype
void ajHetentDel (
      AjPHetent* ptr
);

TypeNameRead/WriteDescription
AjPHetent*ptrDeleteHetent object pointer
void RETURN

Output
ptr:(Delete)Hetent object pointer
Returns
void:No return value

Description

Destructor for Hetent object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetDel

Destructor for Het object.

Synopsis

Prototype
void ajHetDel (
      AjPHet* ptr
);

TypeNameRead/WriteDescription
AjPHet*ptrDeleteHet object pointer
void RETURN

Output
ptr:(Delete)Het object pointer
Returns
void:No return value

Description

Destructor for Het object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVdwallDel

Destructor for Vdwall object.

Synopsis

Prototype
void ajVdwallDel (
      AjPVdwall* ptr
);

TypeNameRead/WriteDescription
AjPVdwall*ptrDeleteVdwall object pointer
void RETURN

Output
ptr:(Delete)Vdwall object pointer
Returns
void:No return value

Description

Destructor for Vdwall object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVdwresDel

Destructor for Vdwres object.

Synopsis

Prototype
void ajVdwresDel (
      AjPVdwres* ptr
);

TypeNameRead/WriteDescription
AjPVdwres*ptrDeleteVdwres object pointer
void RETURN

Output
ptr:(Delete)Vdwres object pointer
Returns
void:No return value

Description

Destructor for Vdwres object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapDel

Destructor for Cmap object.

Synopsis

Prototype
void ajCmapDel (
      AjPCmap* ptr
);

TypeNameRead/WriteDescription
AjPCmap*ptrDeleteCmap object pointer
void RETURN

Output
ptr:(Delete)Cmap object pointer
Returns
void:No return value

Description

Destructor for Cmap object.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospDel

Destructor for Pdbtosp object.

Synopsis

Prototype
void ajPdbtospDel (
      AjPPdbtosp* ptr
);

TypeNameRead/WriteDescription
AjPPdbtosp*ptrDeletePdbtosp object pointer
void RETURN

Output
ptr:(Delete)Pdbtosp object pointer
Returns
void:No return value

Description

Destructor for Pdbtosp object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Assignments

These functions overwrite the instance provided as the first argument A NULL value is always acceptable so these functions are often used to create a new instance by assignment.

Functions: ajAtomCopy ajResidueCopy ajAtomListCopy ajResidueListCopy ajPdbCopy

Function ajAtomCopy

Copies the data from an Atom object to an Atom object; the new object is created if needed.

IMPORTANT - THIS DOES NOT COPY THE eNum & eType ELEMENTS, WHICH ARE SET TO ZERO and '.' INSTEAD.

Synopsis

Prototype
AjBool ajAtomCopy (
      AjPAtom* to,
      const AjPAtom from
);

TypeNameRead/WriteDescription
AjPAtom*toOutputAtom object pointer
const AjPAtomfromInputAtom object pointer
AjBool RETURNTrue on success

Input
from:(Input)Atom object pointer
Output
to:(Output)Atom object pointer
Returns
AjBool:True on success

Description

Copies the data from an Atom object to an Atom object; the new object is created if needed.

IMPORTANT - THIS DOES NOT COPY THE eNum & eType ELEMENTS, WHICH ARE SET TO ZERO and '.' INSTEAD.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueCopy

Copies the data from a Residue object to an Residue object; the new object is created if needed.

IMPORTANT - THIS DOES NOT COPY THE eNum & eType ELEMENTS, WHICH ARE SET TO ZERO and '.' INSTEAD.

Synopsis

Prototype
AjBool ajResidueCopy (
      AjPResidue* to,
      const AjPResidue from
);

TypeNameRead/WriteDescription
AjPResidue*toOutputResidue object pointer
const AjPResiduefromInputResidue object pointer
AjBool RETURNTrue on success

Input
from:(Input)Residue object pointer
Output
to:(Output)Residue object pointer
Returns
AjBool:True on success

Description

Copies the data from a Residue object to an Residue object; the new object is created if needed.

IMPORTANT - THIS DOES NOT COPY THE eNum & eType ELEMENTS, WHICH ARE SET TO ZERO and '.' INSTEAD.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajAtomListCopy

Read a list of Atom structures and writes a copy of the list. The data are copied and the list is created if necessary.

Synopsis

Prototype
AjBool ajAtomListCopy (
      AjPList* to,
      const AjPList from
);

TypeNameRead/WriteDescription
AjPList*toOutputList of Atom objects to write
const AjPListfromInputList of Atom objects to read
AjBool RETURNTrue if list was copied ok.

Input
from:(Input)List of Atom objects to read
Output
to:(Output)List of Atom objects to write
Returns
AjBool:True if list was copied ok.

Description

Read a list of Atom structures and writes a copy of the list. The data are copied and the list is created if necessary.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueListCopy

Read a list of Residue structures and writes a copy of the list. The data are copied and the list is created if necessary.

Synopsis

Prototype
AjBool ajResidueListCopy (
      AjPList* to,
      const AjPList from
);

TypeNameRead/WriteDescription
AjPList*toOutputList of Residue objects to write
const AjPListfromInputList of Residue objects to read
AjBool RETURNTrue if list was copied ok.

Input
from:(Input)List of Residue objects to read
Output
to:(Output)List of Residue objects to write
Returns
AjBool:True if list was copied ok.

Description

Read a list of Residue structures and writes a copy of the list. The data are copied and the list is created if necessary.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbCopy

Copies data from one Pdb object to another; the new object is always created.

Synopsis

Prototype
AjBool ajPdbCopy (
      AjPPdb* to,
      const AjPPdb from
);

TypeNameRead/WriteDescription
AjPPdb*toOutputPdb object pointer
const AjPPdbfromInputPdb object pointer
AjBool RETURNTrue on success

Input
from:(Input)Pdb object pointer
Output
to:(Output)Pdb object pointer
Returns
AjBool:True on success

Description

Copies data from one Pdb object to another; the new object is always created.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Operators

These functions use the contents of an instance but do not make any changes.

Functions: ajResidueSSEnv ajResidueEnv1 ajResidueEnv2 ajResidueEnv3 ajResidueEnv4 ajResidueEnv5 ajResidueEnv6 ajResidueEnv7 ajResidueEnv8 ajResidueEnv9 ajResidueEnv10 ajResidueEnv11 ajResidueEnv12 ajResidueEnv13 ajResidueEnv14 ajResidueEnv15 ajResidueEnv16 ajPdbGetEStrideType

Function ajResidueSSEnv

Assigns secondary structure environment of a residue

Synopsis

Prototype
AjBool ajResidueSSEnv (
      const AjPResidue res,
      char* SEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
char*SEnvOutputCharacter for the Secondary structure environment
AjPFileflogOutputLog file
AjBool RETURNajTrue on success

Input
res:(Input)Residue object
Output
SEnv:(Output)Character for the Secondary structure environment
flog:(Output)Log file
Returns
AjBool:ajTrue on success

Description

Assigns secondary structure environment of a residue

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv1

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv1 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv2

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv2 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv3

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv3 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv4

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv4 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv5

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv5 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv6

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv6 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv7

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv7 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv8

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv8 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv9

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv9 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based only of side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv10

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv10 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv11

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv11 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv12

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv12 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv13

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv13 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv14

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv14 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv15

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv15 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajResidueEnv16

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

Synopsis

Prototype
ajint ajResidueEnv16 (
      const AjPResidue res,
      char SEnv,
      AjPStr* OEnv,
      AjPFile flog
);

TypeNameRead/WriteDescription
const AjPResidueresInputResidue object
charSEnvInputSecondary structure environment code
AjPStr*OEnvOutputCharacter for the overall environment class
AjPFileflogOutputLog file
ajint RETURNNumber of environments

Input
res:(Input)Residue object
SEnv:(Input)Secondary structure environment code
Output
OEnv:(Output)Character for the overall environment class
flog:(Output)Log file
Returns
ajint:Number of environments

Description

Assigns environment based on side chain accessibility and secondary structure. Assigns environment of "*" as default.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbGetEStrideType

Reads a Pdb object and writes a string with the secondary structure. The string that is written is the same length as the full-length chain (regardless of whether coordinates for a residue were available or not) therefore it can be indexed into using residue numbers. The string is allocated if necessary. If secondary structure assignment was not available for a residue a '.' is given in the string.

Synopsis

Prototype
ajint ajPdbGetEStrideType (
      const AjPPdb obj,
      ajint chn,
      AjPStr* EStrideType
);

TypeNameRead/WriteDescription
const AjPPdbobjInputPdb object
ajintchnInputChain number
AjPStr*EStrideTypeOutputString to hold secondary structure
ajint RETURNLength (residues) of array that was written or -1 (for an error)

Input
obj:(Input)Pdb object
chn:(Input)Chain number
Output
EStrideType:(Output)String to hold secondary structure
Returns
ajint:Length (residues) of array that was written or -1 (for an error)

Description

Reads a Pdb object and writes a string with the secondary structure. The string that is written is the same length as the full-length chain (regardless of whether coordinates for a residue were available or not) therefore it can be indexed into using residue numbers. The string is allocated if necessary. If secondary structure assignment was not available for a residue a '.' is given in the string.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Reporters

These functions return the contents of an instance but do not make any changes.

Functions: ajPdbChnidToNum ajPdbtospArrFindPdbid

Function ajPdbChnidToNum

Finds the chain number for a given chain identifier in a pdb structure

Synopsis

Prototype
AjBool ajPdbChnidToNum (
      char id,
      const AjPPdb pdb,
      ajint* chn
);

TypeNameRead/WriteDescription
charidInputChain identifier
const AjPPdbpdbInputPdb object
ajint*chnOutputChain number
AjBool RETURNTrue on success

Input
id:(Input)Chain identifier
pdb:(Input)Pdb object
Output
chn:(Output)Chain number
Returns
AjBool:True on success

Description

Finds the chain number for a given chain identifier in a pdb structure

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospArrFindPdbid

Performs a binary search for a PDB code over an array of Pdbtosp structures (which of course must first have been sorted). This is a case-insensitive search.

Synopsis

Prototype
ajint ajPdbtospArrFindPdbid (
      AjPPdbtosp const* arr,
      ajint siz,
      const AjPStr id
);

TypeNameRead/WriteDescription
AjPPdbtosp const*arrInputArray of AjOPdbtosp objects
ajintsizInputSize of array
const AjPStridInputSearch term
ajint RETURNIndex of first Pdbtosp object found with an PDB code matching id, or -1 if id is not found.

Input
arr:(Input)Array of AjOPdbtosp objects
siz:(Input)Size of array
id:(Input)Search term
Returns
ajint:Index of first Pdbtosp object found with an PDB code matching id, or -1 if id is not found.

Description

Performs a binary search for a PDB code over an array of Pdbtosp structures (which of course must first have been sorted). This is a case-insensitive search.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Input & output

These functions are used for formatted input and output to file.

Functions: ajPdbWriteAll ajPdbWriteSegment ajHetWrite ajPdbtospWrite ajCmapWrite ajPdbExit

Function ajPdbWriteAll

Writes a clean coordinate file for a protein.

Synopsis

Prototype
AjBool ajPdbWriteAll (
      AjPFile outf,
      const AjPPdb obj
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file stream
const AjPPdbobjInputPdb object
AjBool RETURNTrue on success

Input
obj:(Input)Pdb object
Output
outf:(Output)Output file stream
Returns
AjBool:True on success

Description

Writes a clean coordinate file for a protein.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbWriteSegment

Writes a clean coordinate file for a segment, e.g. a domain. The segment corresponds to a sequence that is passed to the function. In the clean coordinate file, the coordinates are presented as belonging to a single chain. Coordinates for heterogens are NOT written to file.

Synopsis

Prototype
AjBool ajPdbWriteSegment (
      AjPFile outf,
      const AjPPdb pdb,
      const AjPStr segment,
      char chnid,
      const AjPStr domain,
      AjPFile errf
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file stream
const AjPPdbpdbInputPdb object
const AjPStrsegmentInputSequence of segment to print out.
charchnidInputChain id of segment
const AjPStrdomainInputDomain code for segment
AjPFileerrfOutputOutput file stream for error messages
AjBool RETURNTrue on success

Input
pdb:(Input)Pdb object
segment:(Input)Sequence of segment to print out.
chnid:(Input)Chain id of segment
domain:(Input)Domain code for segment
Output
outf:(Output)Output file stream
errf:(Output)Output file stream for error messages
Returns
AjBool:True on success

Description

Writes a clean coordinate file for a segment, e.g. a domain. The segment corresponds to a sequence that is passed to the function. In the clean coordinate file, the coordinates are presented as belonging to a single chain. Coordinates for heterogens are NOT written to file.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajHetWrite

Writes the contents of a Het object to file.

Synopsis

Prototype
AjBool ajHetWrite (
      AjPFile outf,
      const AjPHet obj,
      AjBool dogrep
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file
const AjPHetobjInputHet object
AjBooldogrepInputFlag (True if we are to write 'cnt' element of the Het object to file).
AjBool RETURNTrue on success

Input
obj:(Input)Het object
dogrep:(Input)Flag (True if we are to write 'cnt' element of the Het object to file).
Output
outf:(Output)Output file
Returns
AjBool:True on success

Description

Writes the contents of a Het object to file.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbtospWrite

Reads a list of Pdbtosp objects, e.g. taken from the swissprot:pdb equivalence table available at URL: (1) http://www.expasy.ch/cgi-bin/lists?pdbtosp.txt) and writes the list out to file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application).

Synopsis

Prototype
AjBool ajPdbtospWrite (
      AjPFile outf,
      const AjPList list
);

TypeNameRead/WriteDescription
AjPFileoutfOutputOutput file
const AjPListlistInputList of Pdbtosp objects
AjBool RETURNTrue of file was written ok.

Input
list:(Input)List of Pdbtosp objects
Output
outf:(Output)Output file
Returns
AjBool:True of file was written ok.

Description

Reads a list of Pdbtosp objects, e.g. taken from the swissprot:pdb equivalence table available at URL: (1) http://www.expasy.ch/cgi-bin/lists?pdbtosp.txt) and writes the list out to file in embl-like format (see documentation for DOMAINATRIX "pdbtosp" application).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajCmapWrite

Write a Cmap object to file in CON format (see documentation for DOMAINATRIX "contacts" application).

Synopsis

Prototype
AjBool ajCmapWrite (
      AjPFile outf,
      const AjPCmap cmap
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file stream.
const AjPCmapcmapInputCmap object pointer.
AjBool RETURNTrue on success (object was written successfully)

Input
cmap:(Input)Cmap object pointer.
Input & Output
outf:(Modify)Output file stream.
Returns
AjBool:True on success (object was written successfully)

Description

Write a Cmap object to file in CON format (see documentation for DOMAINATRIX "contacts" application).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajPdbExit

Cleanup of Pdb function internals.

Synopsis

Prototype
void ajPdbExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleanup of Pdb function internals.

See Also

See other functions in this section

Availability

In release 6.4.0