Gemmi C++ API
Loading...
Searching...
No Matches
Classes | Public Member Functions | Public Attributes | List of all members
gemmi::cif::Ddl Struct Reference

Represents DDL1 or DDL2 dictionary (ontology). More...

#include <ddl.hpp>

Public Member Functions

 Ddl ()=default
 
 Ddl (Ddl const &)=delete
 
Ddloperator= (Ddl const &)=delete
 
void read_ddl (cif::Document &&doc)
 it moves doc to ddl_docs_ to control lifetime and prevent modifications
 
bool validate_cif (const cif::Document &doc) const
 
bool validate_block (const cif::Block &b, const std::string &source) const
 
void check_audit_conform (const cif::Document &doc) const
 
const std::map< std::string, std::regex > & regexes () const
 

Public Attributes

Logger logger
 member functions use logger's callback and threshold for output
 
bool print_unknown_tags = true
 
bool use_regex = true
 
bool use_context = false
 
bool use_parents = false
 
bool use_mandatory = true
 
bool use_unique_keys = true
 
bool use_deposition_checks = false
 
int major_version = 0
 
std::string dict_name
 
std::string dict_version
 

Detailed Description

Represents DDL1 or DDL2 dictionary (ontology).

Definition at line 17 of file ddl.hpp.

Constructor & Destructor Documentation

◆ Ddl() [1/2]

gemmi::cif::Ddl::Ddl ( )
default

◆ Ddl() [2/2]

gemmi::cif::Ddl::Ddl ( Ddl const )
delete

Member Function Documentation

◆ operator=()

Ddl & gemmi::cif::Ddl::operator= ( Ddl const )
delete

◆ read_ddl()

void gemmi::cif::Ddl::read_ddl ( cif::Document &&  doc)

it moves doc to ddl_docs_ to control lifetime and prevent modifications

◆ validate_cif()

bool gemmi::cif::Ddl::validate_cif ( const cif::Document doc) const

◆ validate_block()

bool gemmi::cif::Ddl::validate_block ( const cif::Block b,
const std::string &  source 
) const

◆ check_audit_conform()

void gemmi::cif::Ddl::check_audit_conform ( const cif::Document doc) const

◆ regexes()

const std::map< std::string, std::regex > & gemmi::cif::Ddl::regexes ( ) const
inline

Definition at line 51 of file ddl.hpp.

Member Data Documentation

◆ logger

Logger gemmi::cif::Ddl::logger

member functions use logger's callback and threshold for output

Definition at line 19 of file ddl.hpp.

◆ print_unknown_tags

bool gemmi::cif::Ddl::print_unknown_tags = true

Definition at line 21 of file ddl.hpp.

◆ use_regex

bool gemmi::cif::Ddl::use_regex = true

Definition at line 23 of file ddl.hpp.

◆ use_context

bool gemmi::cif::Ddl::use_context = false

Definition at line 24 of file ddl.hpp.

◆ use_parents

bool gemmi::cif::Ddl::use_parents = false

Definition at line 25 of file ddl.hpp.

◆ use_mandatory

bool gemmi::cif::Ddl::use_mandatory = true

Definition at line 26 of file ddl.hpp.

◆ use_unique_keys

bool gemmi::cif::Ddl::use_unique_keys = true

Definition at line 27 of file ddl.hpp.

◆ use_deposition_checks

bool gemmi::cif::Ddl::use_deposition_checks = false

Definition at line 30 of file ddl.hpp.

◆ major_version

int gemmi::cif::Ddl::major_version = 0

Definition at line 33 of file ddl.hpp.

◆ dict_name

std::string gemmi::cif::Ddl::dict_name

Definition at line 34 of file ddl.hpp.

◆ dict_version

std::string gemmi::cif::Ddl::dict_version

Definition at line 35 of file ddl.hpp.


The documentation for this struct was generated from the following file: