BioSimSpace._SireWrappers.SearchResult#

class BioSimSpace._SireWrappers.SearchResult(select_result)[source]#

A thin wrapper around Sire.Mol.SelectResult.

__init__(select_result)[source]#

Constructor.

Parameters:

select_result (Output of a Sire search) – The Sire result object.

Methods

__init__(select_result)

Constructor.

atoms()

Return all of the atoms that contain the results of this search.

bonds()

Return all of the bonds in this result.

chains()

Return all of the chains that contain the results of this search.

copy()

Create a copy of this object.

getResult(index)

Return the result at the given index.

molecules()

Return all of the molecules that contain the results of this search.

nResults()

Return the number of results.

residues()

Return all of the residues that contain the results of this search.

segments()

Return all of the segments that contain the results of this search.

atoms()[source]#

Return all of the atoms that contain the results of this search.

Returns:

search_result – A copy of the object viewed via its atoms.

Return type:

SearchResult

bonds()[source]#

Return all of the bonds in this result.

Returns:

search_result – A copy of the object viewed via its bonds.

Return type:

SearchResult

chains()[source]#

Return all of the chains that contain the results of this search.

Returns:

search_result – A copy of the object viewed via its chains.

Return type:

SearchResult

copy()[source]#

Create a copy of this object.

Returns:

search_result – A copy of the object.

Return type:

SearchResult

getResult(index)[source]#

Return the result at the given index.

Parameters:

index (int) – The index of the result.

Returns:

molecules()[source]#

Return all of the molecules that contain the results of this search.

Returns:

search_result – A copy of the object viewed via its molecules.

Return type:

SearchResult

nResults()[source]#

Return the number of results.

Returns:

num_results – The number of search results.

Return type:

int

residues()[source]#

Return all of the residues that contain the results of this search.

Returns:

search_result – A copy of the object viewed via its residues.

Return type:

SearchResult

segments()[source]#

Return all of the segments that contain the results of this search.

Returns:

search_result – A copy of the object viewed via its segments.

Return type:

SearchResult