core::conformation::membrane::SpanningTopology Class Reference

Class: Membrane Spanning Topology. More...

#include <SpanningTopology.hh>

Public Member Functions
	SpanningTopology ()
	Constructor. More...
	~SpanningTopology ()
	Destructor. More...
ObjexxFCL::FArray1D< Size >	helix_id ()
	Getters. More...
ObjexxFCL::FArray2D< Size >	span ()
ObjexxFCL::FArray2D< Size >	full_span ()
ObjexxFCL::FArray2D< Size >	relative_tmh_ori ()
utility::vector1< bool >	allow_scoring ()
utility::vector1< bool >	allow_tmh_scoring ()
core::Size	total_residue_in_span_file ()
core::Size	total_tmhelix ()
core::Size	tmh_inserted ()
utility::vector1< bool >	tmregion ()
void	set_helix_id (ObjexxFCL::FArray1D< Size > helix_id)
	Setters. More...
void	set_span (ObjexxFCL::FArray2D< Size > span)
void	set_full_span (ObjexxFCL::FArray2D< Size > full_span)
void	set_relative_tmh_ori (ObjexxFCL::FArray2D< Size > relative_tmh_ori)
void	set_allow_scoring (utility::vector1< bool > allow_scoring)
void	set_allow_tmh_scoring (utility::vector1< bool > allow_tmh_scoring)
void	set_total_residue_in_spanfile (core::Size total)
void	set_total_tmhelix (core::Size total)
void	set_tmh_inserted (core::Size inserted)
void	set_tmregion (utility::vector1< bool >)
core::Size	reset_tmh_insert ()
	Reset # TMH Inserted. More...
void	reset_allowed_scoring ()
	Reset allowed scoring positions. More...
void	shift_span (Size shift_factor)
	Shift membrane spanning by shift factor. More...
void	show ()
	Print tmh spanning info. More...
void	get_subset (utility::vector1< Size > &TMH_list)
	Get a subset of helices from the topology object. More...

Private Member Functions
void	copy_data (SpanningTopology src, SpanningTopology copy)
	Copy Datag. More...

Private Attributes
ObjexxFCL::FArray1D< Size >	helix_id_
ObjexxFCL::FArray2D< Size >	span_
ObjexxFCL::FArray2D< Size >	full_span_
ObjexxFCL::FArray2D< Size >	relative_tmh_ori_
utility::vector1< bool >	allow_scoring_
utility::vector1< bool >	allow_tmh_scoring_
Size	total_residue_in_span_file_
Size	total_tmhelix_
Size	tmh_inserted_
utility::vector1< bool >	tmregion_

Detailed Description

Class: Membrane Spanning Topology.

Stores information describing the membrane spanning topology of a pose. This definition is a dependency for embedding definitions and requires a spanningfile from OCTOPUS for initialization

Constructor & Destructor Documentation

core::conformation::membrane::SpanningTopology::SpanningTopology

(

)

Constructor.

References full_span_, helix_id_, relative_tmh_ori_, span_, and tmregion_.

core::conformation::membrane::SpanningTopology::~SpanningTopology

(

)

Destructor.

Member Function Documentation

utility::vector1< bool > core::conformation::membrane::SpanningTopology::allow_scoring

(

)

References allow_scoring_.

Referenced by set_allow_scoring().

utility::vector1< bool > core::conformation::membrane::SpanningTopology::allow_tmh_scoring

(

)

References allow_tmh_scoring_.

Referenced by set_allow_tmh_scoring().

void core::conformation::membrane::SpanningTopology::copy_data ( SpanningTopology  src, SpanningTopology  copy  )

private

Copy Datag.

Copy Data.

Copy Constructor Helper function

References allow_scoring_, allow_tmh_scoring_, full_span_, helix_id_, relative_tmh_ori_, span_, tmh_inserted_, tmregion_, total_residue_in_span_file_, and total_tmhelix_.

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::full_span

(

)

References full_span_.

Referenced by set_full_span().

void core::conformation::membrane::SpanningTopology::get_subset

(

utility::vector1< Size > &

TMH_list

)

Get a subset of helices from the topology object.

References full_span_, helix_id_, j, relative_tmh_ori_, span_, total_tmhelix_, core::conformation::TR, and utility_exit_with_message.

ObjexxFCL::FArray1D< Size > core::conformation::membrane::SpanningTopology::helix_id

(

)

Getters.

References helix_id_.

Referenced by set_helix_id().

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::relative_tmh_ori

(

)

References relative_tmh_ori_.

Referenced by set_relative_tmh_ori().

void core::conformation::membrane::SpanningTopology::reset_allowed_scoring

(

)

Reset allowed scoring positions.

References allow_scoring_, allow_tmh_scoring_, and tmh_inserted_.

core::Size core::conformation::membrane::SpanningTopology::reset_tmh_insert

(

)

Reset # TMH Inserted.

References tmh_inserted_.

void core::conformation::membrane::SpanningTopology::set_allow_scoring

(

utility::vector1< bool >

allow_scoring

)

References allow_scoring(), and allow_scoring_.

void core::conformation::membrane::SpanningTopology::set_allow_tmh_scoring

(

utility::vector1< bool >

allow_tmh_scoring

)

References allow_tmh_scoring(), and allow_tmh_scoring_.

void core::conformation::membrane::SpanningTopology::set_full_span

(

ObjexxFCL::FArray2D< Size >

full_span

)

References full_span(), and full_span_.

void core::conformation::membrane::SpanningTopology::set_helix_id

(

ObjexxFCL::FArray1D< Size >

helix_id

)

Setters.

References helix_id(), and helix_id_.

void core::conformation::membrane::SpanningTopology::set_relative_tmh_ori

(

ObjexxFCL::FArray2D< Size >

relative_tmh_ori

)

References relative_tmh_ori(), and relative_tmh_ori_.

void core::conformation::membrane::SpanningTopology::set_span

(

ObjexxFCL::FArray2D< Size >

span

)

References span(), and span_.

void core::conformation::membrane::SpanningTopology::set_tmh_inserted

(

core::Size

inserted

)

References tmh_inserted_.

void core::conformation::membrane::SpanningTopology::set_tmregion

(

utility::vector1< bool >

tmregion

)

References tmregion(), and tmregion_.

void core::conformation::membrane::SpanningTopology::set_total_residue_in_spanfile

(

core::Size

total

)

References total_residue_in_span_file_.

void core::conformation::membrane::SpanningTopology::set_total_tmhelix

(

core::Size

total

)

References total_tmhelix_.

void core::conformation::membrane::SpanningTopology::shift_span

(

Size

shift_factor

)

Shift membrane spanning by shift factor.

References full_span_, span_, total_tmhelix_, and utility_exit_with_message.

void core::conformation::membrane::SpanningTopology::show

(

)

Print tmh spanning info.

References span_, total_tmhelix_, and core::conformation::TR.

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::span

(

)

References span_.

Referenced by set_span().

core::Size core::conformation::membrane::SpanningTopology::tmh_inserted

(

)

References tmh_inserted_.

utility::vector1< bool > core::conformation::membrane::SpanningTopology::tmregion

(

)

References tmregion_.

Referenced by set_tmregion().

core::Size core::conformation::membrane::SpanningTopology::total_residue_in_span_file

(

)

References total_residue_in_span_file_.

core::Size core::conformation::membrane::SpanningTopology::total_tmhelix

(

)

References total_tmhelix_.

Member Data Documentation

utility::vector1< bool > core::conformation::membrane::SpanningTopology::allow_scoring_

private

Referenced by allow_scoring(), copy_data(), reset_allowed_scoring(), and set_allow_scoring().

utility::vector1< bool > core::conformation::membrane::SpanningTopology::allow_tmh_scoring_

private

Referenced by allow_tmh_scoring(), copy_data(), reset_allowed_scoring(), and set_allow_tmh_scoring().

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::full_span_

private

Referenced by copy_data(), full_span(), get_subset(), set_full_span(), shift_span(), and SpanningTopology().

ObjexxFCL::FArray1D< Size > core::conformation::membrane::SpanningTopology::helix_id_

private

Referenced by copy_data(), get_subset(), helix_id(), set_helix_id(), and SpanningTopology().

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::relative_tmh_ori_

private

Referenced by copy_data(), get_subset(), relative_tmh_ori(), set_relative_tmh_ori(), and SpanningTopology().

ObjexxFCL::FArray2D< Size > core::conformation::membrane::SpanningTopology::span_

private

Referenced by copy_data(), get_subset(), set_span(), shift_span(), show(), span(), and SpanningTopology().

Size core::conformation::membrane::SpanningTopology::tmh_inserted_

private

Referenced by copy_data(), reset_allowed_scoring(), reset_tmh_insert(), set_tmh_inserted(), and tmh_inserted().

utility::vector1< bool > core::conformation::membrane::SpanningTopology::tmregion_

private

Referenced by copy_data(), set_tmregion(), SpanningTopology(), and tmregion().

Size core::conformation::membrane::SpanningTopology::total_residue_in_span_file_

private

Referenced by copy_data(), set_total_residue_in_spanfile(), and total_residue_in_span_file().

Size core::conformation::membrane::SpanningTopology::total_tmhelix_

private

Referenced by copy_data(), get_subset(), set_total_tmhelix(), shift_span(), show(), and total_tmhelix().

---

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

• symlinks/rosetta/src/core/conformation/membrane/SpanningTopology.hh
• symlinks/rosetta/src/core/conformation/membrane/SpanningTopology.cc