Sails::Glycosite
class Sails::Glycosite
A class representing a glycosite.
The Glycosite class represents a glycosite, which is defined by its model index, chain index, residue index, and optional atom index. Glycosite can be used for set operations such as comparison and sorting.
Summary
Members | Descriptions |
|---|---|
| The model index of the glycosite. |
| The chain index of the glycosite. |
| The residue index of the glycosite. |
| The atom index of the glycosite. |
| Default constructor. |
| Constructor with mark parameter. |
| Constructor with model_idx, chain_idx, and residue_idx parameters. |
| Constructor with model_idx, chain_idx, and residue_idx parameters. |
Overloaded less than operator for the Glycosite struct. | |
|
Members
public intmodel_idx
The model index of the glycosite.
This variable stores the model index of the glycosite.
public intchain_idx
The chain index of the glycosite.
This variable stores the chain index of the glycosite.
public intresidue_idx
The residue index of the glycosite.
This variable stores the residue index of the glycosite.
public intatom_idx
The atom index of the glycosite.
This variable stores the atom index of the glycosite. It is set to -1 by default and is optional.
publicGlycosite() = default
Default constructor.
@constructor Glycosite
Constructs a Glycosite object with default values for model_idx, chain_idx, residue_idx, and atom_idx.
public inline explicitGlycosite(const gemmi::NeighborSearch::Mark & mark)
Constructor with mark parameter.
@constructor Glycosite
Parameters
markThe neighbor search mark used to initialize the Glycosite object.
Constructs a Glycosite object using the provided neighbor search mark. The model_idx is set to 0, and the chain_idx, residue_idx, and atom_idx are set based on the mark.
public inlineGlycosite(const int model_idx, const int chain_idx, const int residue_idx)
Constructor with model_idx, chain_idx, and residue_idx parameters.
@constructor Glycosite
Parameters
model_idxThe model index of the glycosite.chain_idxThe chain index of the glycosite.residue_idxThe residue index of the glycosite.
Constructs a Glycosite object using the provided model index, chain index, and residue index. The atom_idx is set to -1 by default.
public inlineGlycosite(const int model_idx, const int chain_idx, const int residue_idx, const int atom_idx)
Constructor with model_idx, chain_idx, and residue_idx parameters.
@constructor Glycosite
Parameters
model_idxThe model index of the glycosite.chain_idxThe chain index of the glycosite.residue_idxThe residue index of the glycosite.atom_idxThe atom index of the glycosite.
Constructs a Glycosite object using the provided model index, chain index, and residue index.
public inline booloperator<(constGlycosite& other) const
Overloaded less than operator for the Glycosite struct.
Less than operator.
This operator compares two Glycosite structs based on their model_idx, chain_idx, residue_idx, and atom_idx members. It returns true if this Glycosite is less than the other Glycosite, and false otherwise.
Parameters
otherThe Glycosite struct to compare.
Returns
true if this Glycosite is less than the other Glycosite, false otherwise.
Parameters
otherThe Glycosite object to compare with.
Returns
True if this Glycosite object is less than the other Glycosite object, False otherwise.
Compares this Glycosite object with the other Glycosite object based on model_idx, chain_idx, residue_idx, and atom_idx. Returns True if this Glycosite object is less than the other Glycosite object, and False otherwise.