A class representing a secondary structure element. More...

#include <Molecular_secondary_structure_element.h>

Public Member Functions
const SSE_type &	type () const
	Get the value of type *. More...

SSE_type &	type ()
	Set the value of type *. More...

const std::string &	identifier () const
	Get the value of identifier *. More...

std::string &	identifier ()
	Set the value of identifier *. More...

const std::string &	initial_residue_name () const
	Get the value of initial_residue_name *. More...

std::string &	initial_residue_name ()
	Set the value of initial_residue_name *. More...

const char &	initial_chain_identifier () const
	Get the value of initial_chain_identifier *. More...

char &	initial_chain_identifier ()
	Set the value of initial_chain_identifier *. More...

const int &	initial_residue_sequence_number () const
	Get the value of initial_residue_sequence_number *. More...

int &	initial_residue_sequence_number ()
	Set the value of initial_residue_sequence_number *. More...

const char &	initial_residue_insertion_code () const
	Get the value of initial_residue_insertion_code *. More...

char &	initial_residue_insertion_code ()
	Set the value of initial_residue_insertion_code *. More...

const std::string &	terminal_residue_name () const
	Get the value of terminal_residue_name *. More...

std::string &	terminal_residue_name ()
	Set the value of terminal_residue_name *. More...

const char &	terminal_chain_identifier () const
	Get the value of terminal_chain_identifier *. More...

char &	terminal_chain_identifier ()
	Set the value of terminal_chain_identifier *. More...

const int &	terminal_residue_sequence_number () const
	Get the value of terminal_residue_sequence_number *. More...

int &	terminal_residue_sequence_number ()
	Set the value of terminal_residue_sequence_number *. More...

const char &	terminal_residue_insertion_code () const
	Get the value of terminal_residue_insertion_code *. More...

char &	terminal_residue_insertion_code ()
	Set the value of terminal_residue_insertion_code *. More...

const int &	helix_serial_number () const
	Get the value of helix_serial_number *. More...

int &	helix_serial_number ()
	Set the value of helix_serial_number *. More...

const Helix_class &	helix_class () const
	Get the value of helix_class *. More...

Helix_class &	helix_class ()
	Set the value of helix_class *. More...

const std::string &	helix_comment () const
	Get the value of helix_comment *. More...

std::string &	helix_comment ()
	Set the value of helix_comment *. More...

const int &	helix_length () const
	Get the value of helix_length *. More...

int &	helix_length ()
	Set the value of helix_length *. More...

const int &	sheet_strand () const
	Get the value of sheet_strand *. More...

int &	sheet_strand ()
	Set the value of sheet_strand *. More...

const int &	sheet_num_strands () const
	Get the value of sheet_num_strands *. More...

int &	sheet_num_strands ()
	Set the value of sheet_num_strands *. More...

const Sheet_sense &	sheet_sense () const
	Get the value of sheet_sense *. More...

Sheet_sense &	sheet_sense ()
	Set the value of sheet_sense *. More...

const std::string &	sheet_current_strand_atom_name () const
	Get the value of sheet_current_strand_atom_name *. More...

std::string &	sheet_current_strand_atom_name ()
	Set the value of sheet_current_strand_atom_name *. More...

const std::string &	sheet_current_strand_residue_name () const
	Get the value of sheet_current_strand_residue_name *. More...

std::string &	sheet_current_strand_residue_name ()
	Set the value of sheet_current_strand_residue_name *. More...

const char &	sheet_current_strand_chain_identifier () const
	Get the value of sheet_current_strand_chain_identifier *. More...

char &	sheet_current_strand_chain_identifier ()
	Set the value of sheet_current_strand_chain_identifier *. More...

const int &	sheet_current_strand_residue_sequence_number () const
	Get the value of sheet_current_strand_residue_sequence_number *. More...

int &	sheet_current_strand_residue_sequence_number ()
	Set the value of sheet_current_strand_residue_sequence_number *. More...

const char &	sheet_current_strand_residue_insertion_code () const
	Get the value of sheet_current_strand_residue_insertion_code *. More...

char &	sheet_current_strand_residue_insertion_code ()
	Set the value of sheet_current_strand_residue_insertion_code *. More...

const std::string &	sheet_previous_strand_atom_name () const
	Get the value of sheet_previous_strand_atom_name *. More...

std::string &	sheet_previous_strand_atom_name ()
	Set the value of sheet_previous_strand_atom_name *. More...

const std::string &	sheet_previous_strand_residue_name () const
	Get the value of sheet_previous_strand_residue_name *. More...

std::string &	sheet_previous_strand_residue_name ()
	Set the value of sheet_previous_strand_residue_name *. More...

const char &	sheet_previous_strand_chain_identifier () const
	Get the value of sheet_previous_strand_chain_identifier *. More...

char &	sheet_previous_strand_chain_identifier ()
	Set the value of sheet_previous_strand_chain_identifier *. More...

const int &	sheet_previous_strand_residue_sequence_number () const
	Get the value of sheet_previous_strand_residue_sequence_number *. More...

int &	sheet_previous_strand_residue_sequence_number ()
	Set the value of sheet_previous_strand_residue_sequence_number *. More...

const char &	sheet_previous_strand_residue_insertion_code () const
	Get the value of sheet_previous_strand_residue_insertion_code *. More...

char &	sheet_previous_strand_residue_insertion_code ()
	Set the value of sheet_previous_strand_residue_insertion_code *. More...

bool	has_residue (int ressn, char insc=' ') const
	check if this sse has the residue with the input id, without checking the chain More...

bool	has_residue (char ch_id, int ressn, char insc=' ') const
	check if this sse has the residue with the input id, checking the chain More...

bool	has_residue (const Residue &res) const
	check if this sse has the input residue More...

bool	has_atom (const Atom &atom) const
	check if this sse has the input atom More...

Detailed Description

template<class System>
class SBL::CSB::Molecular_secondary_structure_element< System >

A class representing a secondary structure element.

Template Parameters

System The class representing a molecular system, providing the type definitions for its various components

Member Function Documentation

◆ has_atom()

bool has_atom ( const Atom & atom ) const

inline

check if this sse has the input atom

◆ has_residue() [1/3]

bool has_residue	(	char	ch_id,
		int	ressn,
		char	insc = `' '`
	)		const

inline

check if this sse has the residue with the input id, checking the chain

◆ has_residue() [2/3]

bool has_residue ( const Residue & res ) const

inline

check if this sse has the input residue

◆ has_residue() [3/3]

bool has_residue	(	int	ressn,
		char	insc = `' '`
	)		const

inline

check if this sse has the residue with the input id, without checking the chain

◆ helix_class() [1/2]

Helix_class& helix_class ( )

inline

Set the value of helix_class *.

*

Parameters

value The new value of helix_class

◆ helix_class() [2/2]

const Helix_class& helix_class ( ) const

inline

Get the value of helix_class *.

Returns
The value of helix_class

◆ helix_comment() [1/2]

std::string& helix_comment ( )

inline

Set the value of helix_comment *.

*

Parameters

value The new value of helix_comment

◆ helix_comment() [2/2]

const std::string& helix_comment ( ) const

inline

Get the value of helix_comment *.

Returns
The value of helix_comment

◆ helix_length() [1/2]

int& helix_length ( )

inline

Set the value of helix_length *.

*

Parameters

value The new value of helix_length

◆ helix_length() [2/2]

const int& helix_length ( ) const

inline

Get the value of helix_length *.

Returns
The value of helix_length

◆ helix_serial_number() [1/2]

int& helix_serial_number ( )

inline

Set the value of helix_serial_number *.

*

Parameters

value The new value of helix_serial_number

◆ helix_serial_number() [2/2]

const int& helix_serial_number ( ) const

inline

Get the value of helix_serial_number *.

Returns
The value of helix_serial_number

◆ identifier() [1/2]

std::string& identifier ( )

inline

Set the value of identifier *.

*

Parameters

value The new value of identifier

◆ identifier() [2/2]

const std::string& identifier ( ) const

inline

Get the value of identifier *.

Returns
The value of identifier

◆ initial_chain_identifier() [1/2]

char& initial_chain_identifier ( )

inline

Set the value of initial_chain_identifier *.

*

Parameters

value The new value of initial_chain_identifier

◆ initial_chain_identifier() [2/2]

const char& initial_chain_identifier ( ) const

inline

Get the value of initial_chain_identifier *.

Returns
The value of initial_chain_identifier

◆ initial_residue_insertion_code() [1/2]

char& initial_residue_insertion_code ( )

inline

Set the value of initial_residue_insertion_code *.

*

Parameters

value The new value of initial_residue_insertion_code

◆ initial_residue_insertion_code() [2/2]

const char& initial_residue_insertion_code ( ) const

inline

Get the value of initial_residue_insertion_code *.

Returns
The value of initial_residue_insertion_code

◆ initial_residue_name() [1/2]

std::string& initial_residue_name ( )

inline

Set the value of initial_residue_name *.

*

Parameters

value The new value of initial_residue_name

◆ initial_residue_name() [2/2]

const std::string& initial_residue_name ( ) const

inline

Get the value of initial_residue_name *.

Returns
The value of initial_residue_name

◆ initial_residue_sequence_number() [1/2]

int& initial_residue_sequence_number ( )

inline

Set the value of initial_residue_sequence_number *.

*

Parameters

value The new value of initial_residue_sequence_number

◆ initial_residue_sequence_number() [2/2]

const int& initial_residue_sequence_number ( ) const

inline

Get the value of initial_residue_sequence_number *.

Returns
The value of initial_residue_sequence_number

◆ sheet_current_strand_atom_name() [1/2]

std::string& sheet_current_strand_atom_name ( )

inline

Set the value of sheet_current_strand_atom_name *.

*

Parameters

value The new value of sheet_current_strand_atom_name

◆ sheet_current_strand_atom_name() [2/2]

const std::string& sheet_current_strand_atom_name ( ) const

inline

Get the value of sheet_current_strand_atom_name *.

Returns
The value of sheet_current_strand_atom_name

◆ sheet_current_strand_chain_identifier() [1/2]

char& sheet_current_strand_chain_identifier ( )

inline

Set the value of sheet_current_strand_chain_identifier *.

*

Parameters

value The new value of sheet_current_strand_chain_identifier

◆ sheet_current_strand_chain_identifier() [2/2]

const char& sheet_current_strand_chain_identifier ( ) const

inline

Get the value of sheet_current_strand_chain_identifier *.

Returns
The value of sheet_current_strand_chain_identifier

◆ sheet_current_strand_residue_insertion_code() [1/2]

char& sheet_current_strand_residue_insertion_code ( )

inline

Set the value of sheet_current_strand_residue_insertion_code *.

*

Parameters

value The new value of sheet_current_strand_residue_insertion_code

◆ sheet_current_strand_residue_insertion_code() [2/2]

const char& sheet_current_strand_residue_insertion_code ( ) const

inline

Get the value of sheet_current_strand_residue_insertion_code *.

Returns
The value of sheet_current_strand_residue_insertion_code

◆ sheet_current_strand_residue_name() [1/2]

std::string& sheet_current_strand_residue_name ( )

inline

Set the value of sheet_current_strand_residue_name *.

*

Parameters

value The new value of sheet_current_strand_residue_name

◆ sheet_current_strand_residue_name() [2/2]

const std::string& sheet_current_strand_residue_name ( ) const

inline

Get the value of sheet_current_strand_residue_name *.

Returns
The value of sheet_current_strand_residue_name

◆ sheet_current_strand_residue_sequence_number() [1/2]

int& sheet_current_strand_residue_sequence_number ( )

inline

Set the value of sheet_current_strand_residue_sequence_number *.

*

Parameters

value The new value of sheet_current_strand_residue_sequence_number

◆ sheet_current_strand_residue_sequence_number() [2/2]

const int& sheet_current_strand_residue_sequence_number ( ) const

inline

Get the value of sheet_current_strand_residue_sequence_number *.

Returns
The value of sheet_current_strand_residue_sequence_number

◆ sheet_num_strands() [1/2]

int& sheet_num_strands ( )

inline

Set the value of sheet_num_strands *.

*

Parameters

value The new value of sheet_num_strands

◆ sheet_num_strands() [2/2]

const int& sheet_num_strands ( ) const

inline

Get the value of sheet_num_strands *.

Returns
The value of sheet_num_strands

◆ sheet_previous_strand_atom_name() [1/2]

std::string& sheet_previous_strand_atom_name ( )

inline

Set the value of sheet_previous_strand_atom_name *.

*

Parameters

value The new value of sheet_previous_strand_atom_name

◆ sheet_previous_strand_atom_name() [2/2]

const std::string& sheet_previous_strand_atom_name ( ) const

inline

Get the value of sheet_previous_strand_atom_name *.

Returns
The value of sheet_previous_strand_atom_name

◆ sheet_previous_strand_chain_identifier() [1/2]

char& sheet_previous_strand_chain_identifier ( )

inline

Set the value of sheet_previous_strand_chain_identifier *.

*

Parameters

value The new value of sheet_previous_strand_chain_identifier

◆ sheet_previous_strand_chain_identifier() [2/2]

const char& sheet_previous_strand_chain_identifier ( ) const

inline

Get the value of sheet_previous_strand_chain_identifier *.

Returns
The value of sheet_previous_strand_chain_identifier

◆ sheet_previous_strand_residue_insertion_code() [1/2]

char& sheet_previous_strand_residue_insertion_code ( )

inline

Set the value of sheet_previous_strand_residue_insertion_code *.

*

Parameters

value The new value of sheet_previous_strand_residue_insertion_code

◆ sheet_previous_strand_residue_insertion_code() [2/2]

const char& sheet_previous_strand_residue_insertion_code ( ) const

inline

Get the value of sheet_previous_strand_residue_insertion_code *.

Returns
The value of sheet_previous_strand_residue_insertion_code

◆ sheet_previous_strand_residue_name() [1/2]

std::string& sheet_previous_strand_residue_name ( )

inline

Set the value of sheet_previous_strand_residue_name *.

*

Parameters

value The new value of sheet_previous_strand_residue_name

◆ sheet_previous_strand_residue_name() [2/2]

const std::string& sheet_previous_strand_residue_name ( ) const

inline

Get the value of sheet_previous_strand_residue_name *.

Returns
The value of sheet_previous_strand_residue_name

◆ sheet_previous_strand_residue_sequence_number() [1/2]

int& sheet_previous_strand_residue_sequence_number ( )

inline

Set the value of sheet_previous_strand_residue_sequence_number *.

*

Parameters

value The new value of sheet_previous_strand_residue_sequence_number

◆ sheet_previous_strand_residue_sequence_number() [2/2]

const int& sheet_previous_strand_residue_sequence_number ( ) const

inline

Get the value of sheet_previous_strand_residue_sequence_number *.

Returns
The value of sheet_previous_strand_residue_sequence_number

◆ sheet_sense() [1/2]

Sheet_sense& sheet_sense ( )

inline

Set the value of sheet_sense *.

*

Parameters

value The new value of sheet_sense

◆ sheet_sense() [2/2]

const Sheet_sense& sheet_sense ( ) const

inline

Get the value of sheet_sense *.

Returns
The value of sheet_sense

◆ sheet_strand() [1/2]

int& sheet_strand ( )

inline

Set the value of sheet_strand *.

*

Parameters

value The new value of sheet_strand

◆ sheet_strand() [2/2]

const int& sheet_strand ( ) const

inline

Get the value of sheet_strand *.

Returns
The value of sheet_strand

◆ terminal_chain_identifier() [1/2]

char& terminal_chain_identifier ( )

inline

Set the value of terminal_chain_identifier *.

*

Parameters

value The new value of terminal_chain_identifier

◆ terminal_chain_identifier() [2/2]

const char& terminal_chain_identifier ( ) const

inline

Get the value of terminal_chain_identifier *.

Returns
The value of terminal_chain_identifier

◆ terminal_residue_insertion_code() [1/2]

char& terminal_residue_insertion_code ( )

inline

Set the value of terminal_residue_insertion_code *.

*

Parameters

value The new value of terminal_residue_insertion_code

◆ terminal_residue_insertion_code() [2/2]

const char& terminal_residue_insertion_code ( ) const

inline

Get the value of terminal_residue_insertion_code *.

Returns
The value of terminal_residue_insertion_code

◆ terminal_residue_name() [1/2]

std::string& terminal_residue_name ( )

inline

Set the value of terminal_residue_name *.

*

Parameters

value The new value of terminal_residue_name

◆ terminal_residue_name() [2/2]

const std::string& terminal_residue_name ( ) const

inline

Get the value of terminal_residue_name *.

Returns
The value of terminal_residue_name

◆ terminal_residue_sequence_number() [1/2]

int& terminal_residue_sequence_number ( )

inline

Set the value of terminal_residue_sequence_number *.

*

Parameters

value The new value of terminal_residue_sequence_number

◆ terminal_residue_sequence_number() [2/2]

const int& terminal_residue_sequence_number ( ) const

inline

Get the value of terminal_residue_sequence_number *.

Returns
The value of terminal_residue_sequence_number

◆ type() [1/2]

SSE_type& type ( )

inline

Set the value of type *.

*

Parameters

value The new value of type

◆ type() [2/2]

const SSE_type& type ( ) const

inline

Get the value of type *.

Returns
The value of type

Public Member Functions

Detailed Description

template<class System> class SBL::CSB::Molecular_secondary_structure_element< System >

Member Function Documentation

◆ has_atom()

◆ has_residue() [1/3]

◆ has_residue() [2/3]

◆ has_residue() [3/3]

◆ helix_class() [1/2]

◆ helix_class() [2/2]

◆ helix_comment() [1/2]

◆ helix_comment() [2/2]

◆ helix_length() [1/2]

◆ helix_length() [2/2]

◆ helix_serial_number() [1/2]

◆ helix_serial_number() [2/2]

◆ identifier() [1/2]

◆ identifier() [2/2]

◆ initial_chain_identifier() [1/2]

◆ initial_chain_identifier() [2/2]

◆ initial_residue_insertion_code() [1/2]

◆ initial_residue_insertion_code() [2/2]

◆ initial_residue_name() [1/2]

◆ initial_residue_name() [2/2]

◆ initial_residue_sequence_number() [1/2]

◆ initial_residue_sequence_number() [2/2]

◆ sheet_current_strand_atom_name() [1/2]

◆ sheet_current_strand_atom_name() [2/2]

◆ sheet_current_strand_chain_identifier() [1/2]

◆ sheet_current_strand_chain_identifier() [2/2]

◆ sheet_current_strand_residue_insertion_code() [1/2]

◆ sheet_current_strand_residue_insertion_code() [2/2]

◆ sheet_current_strand_residue_name() [1/2]

◆ sheet_current_strand_residue_name() [2/2]

◆ sheet_current_strand_residue_sequence_number() [1/2]

◆ sheet_current_strand_residue_sequence_number() [2/2]

◆ sheet_num_strands() [1/2]

◆ sheet_num_strands() [2/2]

◆ sheet_previous_strand_atom_name() [1/2]

◆ sheet_previous_strand_atom_name() [2/2]

◆ sheet_previous_strand_chain_identifier() [1/2]

◆ sheet_previous_strand_chain_identifier() [2/2]

◆ sheet_previous_strand_residue_insertion_code() [1/2]

◆ sheet_previous_strand_residue_insertion_code() [2/2]

◆ sheet_previous_strand_residue_name() [1/2]

◆ sheet_previous_strand_residue_name() [2/2]

◆ sheet_previous_strand_residue_sequence_number() [1/2]

◆ sheet_previous_strand_residue_sequence_number() [2/2]

◆ sheet_sense() [1/2]

◆ sheet_sense() [2/2]

◆ sheet_strand() [1/2]

◆ sheet_strand() [2/2]

◆ terminal_chain_identifier() [1/2]

◆ terminal_chain_identifier() [2/2]

◆ terminal_residue_insertion_code() [1/2]

◆ terminal_residue_insertion_code() [2/2]

◆ terminal_residue_name() [1/2]

◆ terminal_residue_name() [2/2]

◆ terminal_residue_sequence_number() [1/2]

◆ terminal_residue_sequence_number() [2/2]

◆ type() [1/2]

◆ type() [2/2]

template<class System>
class SBL::CSB::Molecular_secondary_structure_element< System >