API Reference
Page Hierarchy
Class Hierarchy
File Hierarchy
Full API
Namespaces
Classes and Structs
- Struct category_validator
- Struct Documentation
category_validatorcategory_validator::operator<()category_validator::add_item_validator()category_validator::get_validator_for_item()category_validator::get_validator_for_aliased_item()category_validator::m_namecategory_validator::m_keyscategory_validator::m_groupscategory_validator::m_mandatory_itemscategory_validator::m_item_validators
- Struct Documentation
- Struct item_handle
- Struct Documentation
item_handleitem_handle::operator=()item_handle::operator=()item_handle::operator=()item_handle::os()item_handle::swap()item_handle::as()item_handle::value_or()item_handle::compare()item_handle::operator==()item_handle::operator!=()item_handle::empty()item_handle::operator bool()item_handle::is_null()item_handle::is_unknown()item_handle::text()item_handle::item_handle()item_handle::swap()
- Struct Documentation
- Struct item_validator
- Struct Documentation
item_validatoritem_validator::operator<()item_validator::operator==()item_validator::operator()()item_validator::validate_value()item_validator::m_item_nameitem_validator::m_mandatoryitem_validator::m_typeitem_validator::m_enumsitem_validator::m_defaultitem_validator::m_categoryitem_validator::m_aliases
- Struct Documentation
- Template Struct point_type
- Struct Documentation
point_typepoint_type::value_typepoint_type::point_type()point_type::point_type()point_type::point_type()point_type::point_type()point_type::point_type()point_type::operator=()point_type::operator=()point_type::get_x()point_type::get_x()point_type::set_x()point_type::get_y()point_type::get_y()point_type::set_y()point_type::get_z()point_type::get_z()point_type::set_z()point_type::operator+=()point_type::operator+=()point_type::operator-=()point_type::operator-=()point_type::operator*=()point_type::operator/=()point_type::normalize()point_type::rotate()point_type::rotate()point_type::operator clipper::Coord_orth()point_type::operator==()point_type::operator!=()point_type::length_sq()point_type::length()point_type::m_xpoint_type::m_ypoint_type::m_zpoint_type::operator+()point_type::operator-()point_type::operator-()point_type::operator*()point_type::operator*()point_type::operator/()point_type::operator<<()
- Struct Documentation
- Struct type_validator
- Struct Documentation
type_validatortype_validator::type_validator()type_validator::type_validator()type_validator::type_validator()type_validator::type_validator()type_validator::operator=()type_validator::operator=()type_validator::~type_validator()type_validator::operator<()type_validator::compare()type_validator::m_nametype_validator::m_primitive_typetype_validator::m_rx
- Struct Documentation
- Class atom_type_traits
- Nested Relationships
- Class Documentation
atom_type_traitsatom_type_traits::atom_type_traits()atom_type_traits::atom_type_traits()atom_type_traits::type()atom_type_traits::name()atom_type_traits::symbol()atom_type_traits::weight()atom_type_traits::is_metal()atom_type_traits::radius()atom_type_traits::crystal_ionic_radius()atom_type_traits::effective_ionic_radius()atom_type_traits::ionic_radius()atom_type_traits::wksf()atom_type_traits::elsf()atom_type_traits::has_sf()atom_type_traits::is_element()atom_type_traits::is_metal()atom_type_traits::kWKSFValatom_type_traits::SFData
- Class category
- Nested Relationships
- Class Documentation
categorycategory::key_typecategory::value_provider_typecategory::category()category::category()category::category()category::category()category::operator=()category::~category()category::name()category::key_fields()category::key_items()category::key_field_indices()category::key_item_indices()category::set_validator()category::update_links()category::get_validator()category::get_cat_validator()category::is_valid()category::validate_links()category::operator==()category::operator!=()category::front()category::front()category::back()category::back()category::begin()category::end()category::begin()category::end()category::cbegin()category::cend()category::size()category::max_size()category::empty()category::operator[]()category::operator[]()category::rows()category::rows()category::find()category::find()category::find()category::find()category::find()category::find()category::find()category::find()category::find1()category::find1()category::find1()category::find1()category::find1()category::find1()category::find1()category::find1()category::find1()category::find_first()category::find_first()category::find_first()category::find_first()category::find_first()category::find_first()category::find_first()category::find_first()category::find_max()category::find_max()category::find_min()category::find_min()category::exists()category::contains()category::count()category::has_children()category::has_parents()category::get_children()category::get_parents()category::get_linked()category::erase()category::erase()category::erase()category::erase()category::emplace()category::emplace()category::clear()category::get_unique_id()category::get_unique_id()category::get_unique_value()category::update_value()category::update_value()category::update_value()category::update_value()category::get_column_ix()category::get_column_name()category::add_column()category::remove_column()category::rename_column()category::has_column()category::get_columns()category::get_item_ix()category::get_item_name()category::add_item()category::remove_item()category::rename_item()category::has_item()category::get_items()category::sort()category::reorder_by_index()category::get_tag_order()category::get_item_order()category::write()category::write()category::swap()category::operator<<()
- Class compound
- Class Documentation
compoundcompound::id()compound::name()compound::type()compound::formula()compound::formula_weight()compound::formal_charge()compound::atoms()compound::bonds()compound::get_atom_by_atom_id()compound::atoms_bonded()compound::bond_length()compound::is_water()compound::is_peptide()compound::is_base()compound::one_letter_code()compound::parent_id()
- Class Documentation
- Class compound_factory
- Class Documentation
compound_factorycompound_factory::set_default_dictionary()compound_factory::push_dictionary()compound_factory::push_dictionary()compound_factory::pop_dictionary()compound_factory::is_known_peptide()compound_factory::is_known_base()compound_factory::is_peptide()compound_factory::is_base()compound_factory::is_std_peptide()compound_factory::is_std_base()compound_factory::is_monomer()compound_factory::is_std_monomer()compound_factory::is_water()compound_factory::create()compound_factory::~compound_factory()compound_factory::report_missing_compound()compound_factory::init()compound_factory::instance()compound_factory::clear()
- Class Documentation
- Class condition
- Class Documentation
conditioncondition::condition()condition::condition()condition::condition()condition::condition()condition::operator=()condition::operator=()condition::~condition()condition::prepare()condition::operator()()condition::operator bool()condition::empty()condition::single()condition::swap()condition::operator||()condition::operator&&()condition::operator<<()
- Class Documentation
- Class datablock
- Inheritance Relationships
- Class Documentation
datablockdatablock::datablock()datablock::datablock()datablock::name()datablock::set_name()datablock::set_validator()datablock::get_validator()datablock::is_valid()datablock::is_valid()datablock::validate_links()datablock::operator[]()datablock::operator[]()datablock::get()datablock::get()datablock::emplace()datablock::get_tag_order()datablock::get_item_order()datablock::write()datablock::write()datablock::operator==()datablock::swap_()datablock::operator<<()
- Class file
- Inheritance Relationships
- Class Documentation
filefile::file()file::file()file::file()file::file()file::set_validator()file::get_validator()file::is_valid()file::is_valid()file::validate_links()file::load_dictionary()file::load_dictionary()file::contains()file::front()file::front()file::operator[]()file::operator[]()file::emplace()file::load()file::load()file::save()file::save()file::operator<<()
- Template Class basic_ifstream
- Inheritance Relationships
- Class Documentation
basic_ifstreambasic_ifstream::basic_ifstream()basic_ifstream::basic_ifstream()basic_ifstream::basic_ifstream()basic_ifstream::basic_ifstream()basic_ifstream::operator=()basic_ifstream::open()basic_ifstream::open()basic_ifstream::open()basic_ifstream::is_open()basic_ifstream::close()basic_ifstream::swap()
- Template Class basic_ofstream
- Inheritance Relationships
- Class Documentation
basic_ofstreambasic_ofstream::basic_ofstream()basic_ofstream::basic_ofstream()basic_ofstream::basic_ofstream()basic_ofstream::basic_ofstream()basic_ofstream::operator=()basic_ofstream::open()basic_ofstream::open()basic_ofstream::open()basic_ofstream::is_open()basic_ofstream::close()basic_ofstream::swap()
- Class atom
- Class Documentation
atomatom::atom()atom::atom()atom::atom()atom::atom()atom::atom()atom::operator bool()atom::operator=()atom::get_property()atom::get_property_int()atom::get_property_float()atom::set_property()atom::set_property()atom::id()atom::get_type()atom::get_location()atom::set_location()atom::translate()atom::rotate()atom::rotate()atom::translate_and_rotate()atom::translate_rotate_and_translate()atom::get_row()atom::get_row_aniso()atom::is_symmetry_copy()atom::symmetry()atom::is_water()atom::get_charge()atom::get_occupancy()atom::get_label_asym_id()atom::get_label_seq_id()atom::get_label_atom_id()atom::get_label_alt_id()atom::get_label_comp_id()atom::get_label_entity_id()atom::get_auth_asym_id()atom::get_auth_seq_id()atom::get_auth_atom_id()atom::get_auth_alt_id()atom::get_auth_comp_id()atom::get_pdb_ins_code()atom::is_alternate()atom::pdb_id()atom::operator==()atom::operator!=()atom::is_back_bone()atom::swap()atom::compare()atom::operator<()atom::operator<<()
- Class Documentation
- Class branch
- Inheritance Relationships
- Class Documentation
branchbranch::branch()branch::branch()branch::operator=()branch::link_atoms()branch::name()branch::weight()branch::get_asym_id()branch::get_entity_id()branch::get_structure()branch::get_structure()branch::get_sugar_by_num()branch::get_sugar_by_num()branch::construct_sugar()branch::construct_sugar()
- Class monomer
- Inheritance Relationships
- Class Documentation
monomermonomer::monomer()monomer::operator=()monomer::monomer()monomer::operator=()monomer::monomer()monomer::is_first_in_chain()monomer::is_last_in_chain()monomer::has_alpha()monomer::has_kappa()monomer::phi()monomer::psi()monomer::alpha()monomer::kappa()monomer::tco()monomer::omega()monomer::nr_of_chis()monomer::chi()monomer::is_cis()monomer::is_complete()monomer::has_alternate_backbone_atoms()monomer::CAlpha()monomer::C()monomer::N()monomer::O()monomer::H()monomer::is_bonded_to()monomer::chiral_volume()monomer::operator==()monomer::create_new_atom()monomer::are_bonded()monomer::is_cis()monomer::omega()
- Class residue
- Inheritance Relationships
- Class Documentation
residueresidue::residue()residue::residue()residue::get_entity_id()residue::entity_type()residue::get_asym_id()residue::get_seq_id()residue::get_auth_asym_id()residue::get_auth_seq_id()residue::get_pdb_ins_code()residue::get_compound_id()residue::set_compound_id()residue::get_structure()residue::atoms()residue::atoms()residue::add_atom()residue::unique_atoms()residue::get_atom_by_atom_id()residue::get_atoms_by_id()residue::is_entity()residue::is_water()residue::has_alternate_atoms()residue::has_alternate_atoms_for()residue::get_alternate_ids()residue::get_atom_ids()residue::center_and_radius()residue::operator==()residue::create_new_atom()residue::operator<<()
- Class structure
- Class Documentation
structurestructure::structure()structure::structure()structure::structure()structure::operator=()structure::~structure()structure::get_model_nr()structure::atoms()structure::get_entity_type_for_entity_id()structure::get_entity_type_for_asym_id()structure::polymers()structure::polymers()structure::get_polymer_by_asym_id()structure::get_polymer_by_asym_id()structure::branches()structure::branches()structure::get_branch_by_asym_id()structure::get_branch_by_asym_id()structure::non_polymers()structure::has_atom_id()structure::get_atom_by_id()structure::get_atom_by_label()structure::get_atom_by_position()structure::get_atom_by_position_and_type()structure::create_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::get_residue()structure::remove_atom()structure::swap_atoms()structure::move_atom()structure::change_residue()structure::remove_residue()structure::create_non_poly_entity()structure::create_non_poly()structure::create_non_poly()structure::create_water()structure::create_branch()structure::remove_branch()structure::remove_residue()structure::translate()structure::rotate()structure::translate_and_rotate()structure::translate_rotate_and_translate()structure::cleanup_empty_categories()structure::get_category()structure::get_datablock()structure::validate_atoms()structure::emplace_atom()structure::emplace_atom()structure::reorder_atoms()
- Class Documentation
- Template Class quaternion_type
- Class Documentation
quaternion_typequaternion_type::value_typequaternion_type::quaternion_type()quaternion_type::quaternion_type()quaternion_type::quaternion_type()quaternion_type::quaternion_type()quaternion_type::quaternion_type()quaternion_type::real()quaternion_type::unreal()quaternion_type::swap()quaternion_type::operator=()quaternion_type::operator=()quaternion_type::operator=()quaternion_type::operator=()quaternion_type::operator+=()quaternion_type::operator+=()quaternion_type::operator+=()quaternion_type::operator-=()quaternion_type::operator-=()quaternion_type::operator-=()quaternion_type::operator*=()quaternion_type::operator*=()quaternion_type::operator*=()quaternion_type::operator/=()quaternion_type::operator/=()quaternion_type::operator/=()quaternion_type::get_a()quaternion_type::get_b()quaternion_type::get_c()quaternion_type::get_d()quaternion_type::operator==()quaternion_type::operator!=()quaternion_type::operator bool()quaternion_type::operator*()quaternion_type::normalize()quaternion_type::conj()
- Class Documentation
- Class row_handle
- Class Documentation
row_handlerow_handle::row_handle()row_handle::get_category()row_handle::empty()row_handle::operator bool()row_handle::operator[]()row_handle::operator[]()row_handle::operator[]()row_handle::operator[]()row_handle::get()row_handle::get()row_handle::get()row_handle::get()row_handle::assign()row_handle::assign()row_handle::assign()row_handle::operator==()row_handle::operator!=()
- Class Documentation
- Class sac_parser
- Inheritance Relationships
- Class Documentation
sac_parsersac_parser::CharTraitsMasksac_parser::parse_single_datablock()sac_parser::index_datablocks()sac_parser::parse_single_datablock()sac_parser::parse_file()sac_parser::is_space()sac_parser::is_white()sac_parser::is_ordinary()sac_parser::is_non_blank()sac_parser::is_text_lead()sac_parser::is_any_print()sac_parser::is_unquoted_string()
- Class validator
- Class Documentation
validatorvalidator::validator()validator::~validator()validator::validator()validator::operator=()validator::validator()validator::operator=()validator::add_type_validator()validator::get_validator_for_type()validator::add_category_validator()validator::get_validator_for_category()validator::add_link_validator()validator::get_links_for_parent()validator::get_links_for_child()validator::report_error()validator::report_error()validator::report_error()validator::report_error()validator::name()validator::set_name()validator::version()validator::set_version()
- Class Documentation
Enums
- Enum atom_type
- Enum Documentation
atom_typeatom_type::Nnatom_type::Hatom_type::Heatom_type::Liatom_type::Beatom_type::Batom_type::Catom_type::Natom_type::Oatom_type::Fatom_type::Neatom_type::Naatom_type::Mgatom_type::Alatom_type::Siatom_type::Patom_type::Satom_type::Clatom_type::Aratom_type::Katom_type::Caatom_type::Scatom_type::Tiatom_type::Vatom_type::Cratom_type::Mnatom_type::Featom_type::Coatom_type::Niatom_type::Cuatom_type::Znatom_type::Gaatom_type::Geatom_type::Asatom_type::Seatom_type::Bratom_type::Kratom_type::Rbatom_type::Sratom_type::Yatom_type::Zratom_type::Nbatom_type::Moatom_type::Tcatom_type::Ruatom_type::Rhatom_type::Pdatom_type::Agatom_type::Cdatom_type::Inatom_type::Snatom_type::Sbatom_type::Teatom_type::Iatom_type::Xeatom_type::Csatom_type::Baatom_type::Laatom_type::Hfatom_type::Taatom_type::Watom_type::Reatom_type::Osatom_type::Iratom_type::Ptatom_type::Auatom_type::Hgatom_type::Tlatom_type::Pbatom_type::Biatom_type::Poatom_type::Atatom_type::Rnatom_type::Fratom_type::Raatom_type::Acatom_type::Rfatom_type::Dbatom_type::Sgatom_type::Bhatom_type::Hsatom_type::Mtatom_type::Dsatom_type::Rgatom_type::Cnatom_type::Nhatom_type::Flatom_type::Mcatom_type::Lvatom_type::Tsatom_type::Ogatom_type::Ceatom_type::Pratom_type::Ndatom_type::Pmatom_type::Smatom_type::Euatom_type::Gdatom_type::Tbatom_type::Dyatom_type::Hoatom_type::Eratom_type::Tmatom_type::Ybatom_type::Luatom_type::Thatom_type::Paatom_type::Uatom_type::Npatom_type::Puatom_type::Amatom_type::Cmatom_type::Bkatom_type::Cfatom_type::Esatom_type::Fmatom_type::Mdatom_type::Noatom_type::Lratom_type::D
- Enum Documentation
- Enum validation_error
- Enum Documentation
validation_errorvalidation_error::value_does_not_match_rxvalidation_error::value_is_not_in_enumeration_listvalidation_error::not_a_known_primitive_typevalidation_error::undefined_categoryvalidation_error::unknown_itemvalidation_error::incorrect_item_validatorvalidation_error::missing_mandatory_itemsvalidation_error::missing_key_itemsvalidation_error::item_not_allowed_in_categoryvalidation_error::empty_filevalidation_error::empty_datablockvalidation_error::empty_categoryvalidation_error::not_valid_pdbx
- Enum Documentation