CDPL.Biomol.ControlParameter Class Reference

Provides keys for built-in control-parameters. More...

Inheritance diagram for CDPL.Biomol.ControlParameter:

Static Public Attributes
	STRICT_ERROR_CHECKING = CDPL.Base.LookupKey('STRICT_ERROR_CHECKING')
	Specifies whether non-fatal recoverable I/O errors should be ignored or cause an I/O operation to fail. More...
	CHECK_LINE_LENGTH = CDPL.Base.LookupKey('CHECK_LINE_LENGTH')
	Specifies whether to check if data lines exceed the maximum allowed line length when reading or writing data in PDB [PDB] format. More...
	PDB_RESIDUE_DICTIONARY = CDPL.Base.LookupKey('PDB_RESIDUE_DICTIONARY')
	PDB_APPLY_DICT_ATOM_BONDING_TO_NON_STD_RESIDUES = CDPL.Base.LookupKey('PDB_APPLY_DICT_ATOM_BONDING_TO_NON_STD_RESIDUES')
	PDB_APPLY_DICT_ATOM_BONDING_TO_STD_RESIDUES = CDPL.Base.LookupKey('PDB_APPLY_DICT_ATOM_BONDING_TO_STD_RESIDUES')
	PDB_APPLY_DICT_BOND_ORDERS_TO_NON_STD_RESIDUES = CDPL.Base.LookupKey('PDB_APPLY_DICT_BOND_ORDERS_TO_NON_STD_RESIDUES')
	PDB_IGNORE_CONECT_RECORDS = CDPL.Base.LookupKey('PDB_IGNORE_CONECT_RECORDS')
	PDB_DEDUCE_BOND_ORDERS_FROM_CONECT_RECORDS = CDPL.Base.LookupKey('PDB_DEDUCE_BOND_ORDERS_FROM_CONECT_RECORDS')
	PDB_IGNORE_FORMAL_CHARGE_FIELD = CDPL.Base.LookupKey('PDB_IGNORE_FORMAL_CHARGE_FIELD')
	PDB_APPLY_DICT_FORMAL_ATOM_CHARGES = CDPL.Base.LookupKey('PDB_APPLY_DICT_FORMAL_ATOM_CHARGES')
	PDB_APPLY_DICT_ATOM_TYPES = CDPL.Base.LookupKey('PDB_APPLY_DICT_ATOM_TYPES')
	PDB_CALC_MISSING_FORMAL_CHARGES = CDPL.Base.LookupKey('PDB_CALC_MISSING_FORMAL_CHARGES')
	PDB_PERCEIVE_MISSING_BOND_ORDERS = CDPL.Base.LookupKey('PDB_PERCEIVE_MISSING_BOND_ORDERS')
	PDB_EVALUATE_MASTER_RECORD = CDPL.Base.LookupKey('PDB_EVALUATE_MASTER_RECORD')
	PDB_TRUNCATE_LINES = CDPL.Base.LookupKey('PDB_TRUNCATE_LINES')
	PDB_WRITE_FORMAL_CHARGES = CDPL.Base.LookupKey('PDB_WRITE_FORMAL_CHARGES')
	PDB_WRITE_CONECT_RECORDS = CDPL.Base.LookupKey('PDB_WRITE_CONECT_RECORDS')
	PDB_WRITE_CONECT_RECORDS_FOR_ALL_BONDS = CDPL.Base.LookupKey('PDB_WRITE_CONECT_RECORDS_FOR_ALL_BONDS')
	PDB_WRITE_CONECT_RECORDS_REFLECTING_BOND_ORDER = CDPL.Base.LookupKey('PDB_WRITE_CONECT_RECORDS_REFLECTING_BOND_ORDER')
	PDB_FORMAT_VERSION = CDPL.Base.LookupKey('PDB_FORMAT_VERSION')
	COMBINE_INTERFERING_RESIDUE_COORDINATES = CDPL.Base.LookupKey('COMBINE_INTERFERING_RESIDUE_COORDINATES')

Detailed Description

Provides keys for built-in control-parameters.

Member Data Documentation

STRICT_ERROR_CHECKING

CDPL.Biomol.ControlParameter.STRICT_ERROR_CHECKING = CDPL.Base.LookupKey('STRICT_ERROR_CHECKING')

static

Specifies whether non-fatal recoverable I/O errors should be ignored or cause an I/O operation to fail.

If the control-parameter is set to True, not only severe errors cause an I/O operation to fail, but also non-fatal errors from which a recovery would be possible. If the control-parameter is set to False, I/O operations will proceed even if a non-fatal error has been detected.

Value Type: bool

CHECK_LINE_LENGTH

CDPL.Biomol.ControlParameter.CHECK_LINE_LENGTH = CDPL.Base.LookupKey('CHECK_LINE_LENGTH')

static

Specifies whether to check if data lines exceed the maximum allowed line length when reading or writing data in PDB [PDB] format.

If the control-parameter is set to True, the length of data lines that were read from or have to be written to data encoded in one of the above mentioned formats will be checked against the maximum allowed line length. Lines that exceeded the line length limit are considered as an error condition and cause the input or output operation to fail. If CHECK_LINE_LENGTH is False, the length of data lines will not be checked and has no impact on the success of the performed I/O operation.

Value Type: bool