protocols::helical_bundle::parameters::BundleParameters Class Reference

Parameters class, used to store sets of parameters for parametric backbone generation. More...

#include <BundleParameters.hh>

Inheritance diagram for protocols::helical_bundle::parameters::BundleParameters:

Public Types
typedef core::conformation::parametric::Parameters	Parameters
typedef core::conformation::parametric::ParametersOP	ParametersOP
typedef core::conformation::parametric::ParametersSet	ParametersSet
typedef core::conformation::parametric::ParametersSetOP	ParametersSetOP

Public Member Functions
	BundleParameters ()
	constructors More...
	BundleParameters (BundleParameters const &src)
	~BundleParameters () override
ParametersOP	clone () const override
	Copy this residue( allocate actual memory for it ) More...
virtual void	get_pdb_remark (std::stringstream &remark) const
	Get a summary of this ParametersSet object, for output to remark lines of a PDB file. More...
Public Member Functions inherited from core::conformation::parametric::Parameters
	Parameters ()
	constructors More...
	Parameters (Parameters const &src)
	Copy constructor. More...
	~Parameters () override
ParametersCOP	get_self_ptr () const
	self pointers More...
ParametersOP	get_self_ptr ()
ParametersCAP	get_self_weak_ptr () const
ParametersAP	get_self_weak_ptr ()
void	add_residue (core::conformation::ResidueCOP residue)
	Add a residue to the list of residues that these parameters describe. More...
core::conformation::ResidueCOP	residue (core::Size const index) const
	Get an owning pointer to a residue in the list of residues that these parameters describe. More...
core::conformation::ResidueCOP	first_residue () const
	Get a const owning pointer to the first residue in the list of residues that these parameters describe. More...
core::conformation::ResidueCOP	last_residue () const
	Get a const owning pointer to the last residue in the list of residues that these parameters describe. More...
core::Size	first_residue_index () const
	Get the index of the first residue. More...
core::Size	last_residue_index () const
	Get the index of the last residue. More...
core::Size	n_residue () const
	Returns the number (count) of residues that these parameters describe. More...
void	reset_residue_list ()
	Clears the list of residues that these parameters describe. More...
void	reset_sampling_and_perturbing_info () const
	Clears the sampling and perturbing information in the individual parameters. More...
void	set_residue (core::Size const index, core::conformation::ResidueCOP existing_residue)
	Assign an element in the residue list to be an owning pointer to an existing residue. More...
core::Size	num_parameters () const
	Get the number of parameters stored in this Parameters object. More...
void	add_parameter (ParameterOP parameter)
	Add a parameter. More...
ParameterOP	parameter_op (core::Size const index) const
	Access a parameter, by index. More...
ParameterCOP	parameter_cop (core::Size const index) const
	Access a parameter, by index. More...
void	replace_parameter_via_clone (core::Size const param_index, ParameterCOP new_parameter, bool const reset_sampling_copying_perturbing=true)
	Replace one of the contained parameter objects with a copy of an input parameter object. More...

Detailed Description

Parameters class, used to store sets of parameters for parametric backbone generation.

Member Typedef Documentation

typedef core::conformation::parametric::Parameters protocols::helical_bundle::parameters::BundleParameters::Parameters

typedef core::conformation::parametric::ParametersOP protocols::helical_bundle::parameters::BundleParameters::ParametersOP

typedef core::conformation::parametric::ParametersSet protocols::helical_bundle::parameters::BundleParameters::ParametersSet

typedef core::conformation::parametric::ParametersSetOP protocols::helical_bundle::parameters::BundleParameters::ParametersSetOP

Constructor & Destructor Documentation

protocols::helical_bundle::parameters::BundleParameters::BundleParameters

(

)

constructors

Constructor.

protocols::helical_bundle::parameters::BundleParameters::BundleParameters

(

BundleParameters const &

src

)

protocols::helical_bundle::parameters::BundleParameters::~BundleParameters ( )

overridedefault

Member Function Documentation

core::conformation::parametric::ParametersOP protocols::helical_bundle::parameters::BundleParameters::clone ( ) const

overridevirtual

Copy this residue( allocate actual memory for it )

make a copy of this residue( allocate actual memory for it )

Reimplemented from core::conformation::parametric::Parameters.

void protocols::helical_bundle::parameters::BundleParameters::get_pdb_remark ( std::stringstream &  remark ) const

virtual

Get a summary of this ParametersSet object, for output to remark lines of a PDB file.

References protocols::helical_bundle::BPC_end_of_list, protocols::helical_bundle::BPC_last_parameter_to_be_sampled, core::conformation::parametric::Parameters::parameter_cop(), core::conformation::parametric::PT_angle, core::conformation::parametric::PT_angle_vector, core::conformation::parametric::PT_boolean, core::conformation::parametric::PT_generic_integer, core::conformation::parametric::PT_generic_integer_vector, core::conformation::parametric::PT_generic_natural_number, core::conformation::parametric::PT_generic_natural_number_vector, core::conformation::parametric::PT_generic_nonnegative_valued_real, core::conformation::parametric::PT_generic_nonnegative_valued_real_vector, core::conformation::parametric::PT_generic_positive_valued_real, core::conformation::parametric::PT_generic_positive_valued_real_vector, core::conformation::parametric::PT_generic_real, core::conformation::parametric::PT_generic_real_vector, core::conformation::parametric::PT_generic_whole_number, core::conformation::parametric::PT_generic_whole_number_vector, and core::conformation::parametric::PT_invalid_type.

---

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

• src/protocols/helical_bundle/parameters/BundleParameters.hh
• src/protocols/helical_bundle/parameters/BundleParameters.cc