OpenStructure
Public Member Functions
Query Class Reference

#include <query.hh>

Public Member Functions

 Query (const String &query_string="")
 
 Query (const impl::QueryImplP &impl)
 
bool IsAtomSelected (const AtomHandle &ah) const
 
bool IsChainSelected (const ChainHandle &chain) const
 
bool IsResidueSelected (const ResidueHandle &residue) const
 
const StringGetQueryString () const
 
const QueryErrorDescGetErrorDescription () const
 
QueryState CreateQueryState (const EntityView &view) const
 
QueryState CreateQueryState (const EntityHandle &view) const
 
bool IsValid () const
 
bool MatchAll () const
 
impl::QueryImplP Impl ()
 
const impl::QueryImplPImpl () const
 

Detailed Description

Selection Query.

The query system is described here in more detail.

Definition at line 74 of file query.hh.

Constructor & Destructor Documentation

◆ Query() [1/2]

Query ( const String query_string = "")

Construct new query object.

◆ Query() [2/2]

Query ( const impl::QueryImplP impl)

internally used constructor

Member Function Documentation

◆ CreateQueryState() [1/2]

QueryState CreateQueryState ( const EntityHandle view) const

create new query state to be used for a given entity

◆ CreateQueryState() [2/2]

QueryState CreateQueryState ( const EntityView view) const

create new query state to be used for a given entity

◆ GetErrorDescription()

const QueryErrorDesc& GetErrorDescription ( ) const

◆ GetQueryString()

const String& GetQueryString ( ) const

Get String.

◆ Impl() [1/2]

impl::QueryImplP Impl ( )

◆ Impl() [2/2]

const impl::QueryImplP& Impl ( ) const

◆ IsAtomSelected()

bool IsAtomSelected ( const AtomHandle ah) const

whether atom fulfills the query

◆ IsChainSelected()

bool IsChainSelected ( const ChainHandle chain) const

whether chain fulfills the query

True is returned if at least one of the atoms of the chain is selected by the query

◆ IsResidueSelected()

bool IsResidueSelected ( const ResidueHandle residue) const

whether residue fulfills the query

True is returned if at least one of the atoms of the residue is selected by the query

◆ IsValid()

bool IsValid ( ) const

◆ MatchAll()

bool MatchAll ( ) const

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