OpenStructure
Public Types
QueryFlag Struct Reference

#include <query.hh>

Public Types

enum  Flag { EXCLUSIVE_BONDS = 1, NO_BONDS = 2, MATCH_RESIDUES = 4 }

Detailed Description

query flags

Query flags influence the evaluation of Select statements for EntityView and EntityHandle. By default, only inclusive bonds, i.e. bonds whose involved atoms are both part of the resulting view are included in the view. This can be changed by passing EXCLUSIVE_BONDS or NO_BONDS to the Select call. EXCLUSIVE_BONDS adds bonds as soon as one of the two bonding parters evaluates to true. NO_BONDS suppresses the bond inclusion step. This is mostly used as a speed optimisation.

If MATCH_RESIDUES is present, the matching behaviour is changed: Instead of including only atoms for which the query evaluates to true, all atoms of residues for which at least one atom matches the query are added to the resulting view.

For matching GenericProperties, use gapropname, grpropname, gcpropname for the GenericProp 'propname' at the atom, residue and chain level respectively. The g marks the property as generic.

Definition at line 61 of file query.hh.


Member Enumeration Documentation

enum Flag
Enumerator:
EXCLUSIVE_BONDS 
NO_BONDS 
MATCH_RESIDUES 

Definition at line 62 of file query.hh.


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