core::scoring::dssp::Pairing Class Reference

#include <PairingsList.hh>

Public Member Functions
	Pairing ()
	Pairing (core::Size pos1_in, core::Size pos2_in)
	Pairing (ObjexxFCL::FArray1A_int)
	Pairing (core::Size pos1_in, core::Size pos2_in, core::Size ori_in, core::Size pleat_in)
Size	Pos1 () const
void	Pos1 (Size pos1)
Size	Pos2 () const
void	Pos2 (Size pos2)
Size	Orientation () const
void	Orientation (Size orientation)
Size	Pleating () const
void	Pleating (Size pleating)
Pairing	reverse ()
	reverses the Pairing More...
Pairing	generate_reversed () const
	returns a new reversed pairing More...
bool	is_parallel () const
bool	is_anti () const
bool	is_inwards () const
bool	is_outwards () const
bool	operator== (Pairing const &p) const
Size	get_register ()
bool	operator< (Pairing const &p) const

Static Public Attributes
static core::Size const	ANTI = 1
	constant values that define orientation More...
static core::Size const	PARALLEL = 2
static core::Size const	OUTWARDS = 1
static core::Size const	INWARDS = 2

Private Attributes
Size	pos1_
Size	pos2_
Size	orientation_
Size	pleating_

Constructor & Destructor Documentation

Pairing() [1/4]

core::scoring::dssp::Pairing::Pairing ( )

inline

Pairing() [2/4]

core::scoring::dssp::Pairing::Pairing ( core::Size  pos1_in, core::Size  pos2_in  )

inline

Pairing() [3/4]

core::scoring::dssp::Pairing::Pairing

(

ObjexxFCL::FArray1A_int

data

)

Pairing() [4/4]

core::scoring::dssp::Pairing::Pairing ( core::Size  pos1_in, core::Size  pos2_in, core::Size  ori_in, core::Size  pleat_in  )

inline

Member Function Documentation

generate_reversed()

Pairing core::scoring::dssp::Pairing::generate_reversed

(

)

const

returns a new reversed pairing

References reverse().

get_register()

Size core::scoring::dssp::Pairing::get_register ( )

inline

References is_anti(), Pos1(), and Pos2().

is_anti()

bool core::scoring::dssp::Pairing::is_anti ( ) const

inline

References ANTI, and orientation_.

Referenced by core::scoring::dssp::StrandPairingSet::add_pairing(), get_register(), core::scoring::dssp::StrandPairing::has_pairing(), and core::scoring::dssp::StrandPairingSet::has_pairing().

is_inwards()

bool core::scoring::dssp::Pairing::is_inwards ( ) const

inline

References INWARDS, and pleating_.

Referenced by core::scoring::dssp::operator<<().

is_outwards()

bool core::scoring::dssp::Pairing::is_outwards ( ) const

inline

References OUTWARDS, and pleating_.

is_parallel()

bool core::scoring::dssp::Pairing::is_parallel ( ) const

inline

References orientation_, and PARALLEL.

Referenced by core::scoring::dssp::operator<<().

operator<()

bool core::scoring::dssp::Pairing::operator< ( Pairing const &  p ) const

inline

References Orientation(), Pleating(), Pos1(), and Pos2().

operator==()

bool core::scoring::dssp::Pairing::operator== ( Pairing const &  p ) const

inline

References Orientation(), Pleating(), Pos1(), and Pos2().

Orientation() [1/2]

Size core::scoring::dssp::Pairing::Orientation ( ) const

inline

References orientation_.

Referenced by operator<(), core::scoring::dssp::operator<<(), operator==(), and protocols::jumping::JumpSample::steal_orientation_and_pleating().

Orientation() [2/2]

void core::scoring::dssp::Pairing::Orientation ( Size  orientation )

inline

References orientation_.

Pleating() [1/2]

Size core::scoring::dssp::Pairing::Pleating ( ) const

inline

References pleating_.

Referenced by core::scoring::dssp::StrandPairingSet::add_pairing(), protocols::jumping::SheetBuilder::check_two_pairings(), operator<(), core::scoring::dssp::operator<<(), operator==(), and protocols::jumping::JumpSample::steal_orientation_and_pleating().

Pleating() [2/2]

void core::scoring::dssp::Pairing::Pleating ( Size  pleating )

inline

References pleating_.

Pos1() [1/2]

Size core::scoring::dssp::Pairing::Pos1 ( ) const

inline

References pos1_.

Referenced by core::scoring::dssp::StrandPairingSet::add_pairing(), protocols::hybridization::FoldTreeHybridize::add_strand_pairing(), protocols::hybridization::FoldTreeHybridize::add_strand_pairings(), protocols::jumping::SheetBuilder::check_two_pairings(), get_register(), core::scoring::dssp::StrandPairing::has_pairing(), core::scoring::dssp::StrandPairingSet::has_pairing(), operator<(), core::scoring::dssp::operator<<(), operator==(), and protocols::jumping::JumpSample::steal_orientation_and_pleating().

Pos1() [2/2]

void core::scoring::dssp::Pairing::Pos1 ( Size  pos1 )

inline

References pos1_.

Pos2() [1/2]

Size core::scoring::dssp::Pairing::Pos2 ( ) const

inline

References pos2_.

Referenced by core::scoring::dssp::StrandPairingSet::add_pairing(), protocols::hybridization::FoldTreeHybridize::add_strand_pairing(), protocols::hybridization::FoldTreeHybridize::add_strand_pairings(), protocols::jumping::SheetBuilder::check_two_pairings(), get_register(), core::scoring::dssp::StrandPairing::has_pairing(), core::scoring::dssp::StrandPairingSet::has_pairing(), operator<(), core::scoring::dssp::operator<<(), operator==(), and protocols::jumping::JumpSample::steal_orientation_and_pleating().

Pos2() [2/2]

void core::scoring::dssp::Pairing::Pos2 ( Size  pos2 )

inline

References pos2_.

reverse()

Pairing core::scoring::dssp::Pairing::reverse

(

)

reverses the Pairing

References core::chemical::rna::PARALLEL.

Referenced by protocols::jumping::SheetBuilder::check_two_pairings(), generate_reversed(), protocols::abinitio::TemplateJumpSetup::is_helix_jump(), and core::scoring::dssp::read_pairing_list().

Member Data Documentation

ANTI

core::Size const core::scoring::dssp::Pairing::ANTI = 1

static

constant values that define orientation

Referenced by is_anti().

INWARDS

core::Size const core::scoring::dssp::Pairing::INWARDS = 2

static

Referenced by is_inwards().

orientation_

Size core::scoring::dssp::Pairing::orientation_

private

Referenced by is_anti(), is_parallel(), and Orientation().

OUTWARDS

core::Size const core::scoring::dssp::Pairing::OUTWARDS = 1

static

Referenced by is_outwards().

PARALLEL

core::Size const core::scoring::dssp::Pairing::PARALLEL = 2

static

Referenced by is_parallel().

pleating_

Size core::scoring::dssp::Pairing::pleating_

private

Referenced by is_inwards(), is_outwards(), and Pleating().

pos1_

Size core::scoring::dssp::Pairing::pos1_

private

Referenced by Pos1().

pos2_

Size core::scoring::dssp::Pairing::pos2_

private

Referenced by Pos2().

---

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

• src/core/scoring/dssp/PairingsList.hh
• src/core/scoring/dssp/PairingsList.cc