Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
core::conformation::parametric::RealVectorValuedParameter Class Reference

RealVectorValuedParameter class, used to store a single vector-valued parameter for parametric backbone generation. More...

#include <RealVectorValuedParameter.hh>

Inheritance diagram for core::conformation::parametric::RealVectorValuedParameter:
Inheritance graph
[legend]

Public Member Functions

 RealVectorValuedParameter ()
 constructors More...
 
 RealVectorValuedParameter (RealVectorValuedParameter const &src)
 
 ~RealVectorValuedParameter () override
 
ParameterOP clone () const override
 Make a copy of this object ( allocate actual memory for it ) More...
 
utility::vector1< core::Real >
const & 
value () const
 Get the value of this parameter. More...
 
utility::vector1< core::Real >
const & 
default_value () const
 Get the defaults for this parameter. More...
 
void set_value (utility::vector1< core::Real > const &value_in)
 Set the value of this parameter. More...
 
void set_parameter_type (ParameterType const type_in) override
 Sets the parameter type. More...
 
void set_default_value (utility::vector1< core::Real > const &value_in)
 Set the default value for this parameter. More...
 
bool copy_value_from_parameter (ParameterCOP other_parameter, ParametersCOP other_parameter_collection, ParametersCOP this_parameter_collection) override
 Given another parameter of the same type, copy its value. This does not set value_set_ to true. More...
 
void parse_setting (utility::tag::TagCOP tag, bool const parse_setting, bool const parse_grid_sampling, bool const parse_perturbation, bool const parse_copying) override
 Given a tag, parse out the setting for this parameter. More...
 
void provide_xsd_information (utility::tag::AttributeList &xsd, bool const provide_setting, bool const , bool const , bool const ) const override
 Return the XSD information for this parameter. More...
 
void reset_sampling_and_perturbation_settings () override
 Reset the sampling and perturbation options before storing this Parameter object in a parametric Conformation. More...
 
void reset_value_settings () override
 Reset the value settings for this Parameter object. More...
 
- Public Member Functions inherited from core::conformation::parametric::Parameter
 Parameter ()
 constructors More...
 
ParameterCOP get_self_ptr () const
 Self pointers (const shared pointer). More...
 
ParameterOP get_self_ptr ()
 Self pointers (nonconst shared pointer). More...
 
ParameterCAP get_self_weak_ptr () const
 Self pointers (const weak pointer). More...
 
ParameterAP get_self_weak_ptr ()
 Self pointers (nonconst weak pointer). More...
 
std::string const & parameter_name () const
 Get parameter name. More...
 
std::string const & parameter_description () const
 Get parameter description. More...
 
std::string const & short_parameter_description () const
 Get short parameter description. More...
 
std::string const & parameter_units () const
 Get units. More...
 
ParameterType parameter_type () const
 Get the parameter type. More...
 
bool can_be_set () const
 Is this parameter one that can be set directly by the user? More...
 
bool can_be_copied () const
 Is this parameter one that can be copied from another parameter? More...
 
bool can_be_sampled () const
 Is this parameter one that can be sampled? More...
 
bool can_be_perturbed () const
 Is this parameter one that can be perturbed? More...
 
bool global_for_parameters_set () const
 Get whether this property is meant to be global for a parameters set. More...
 
std::string const & copy_suffix () const
 Get the suffix for the copy tag (e.g. "copies_helix" in the case of helical bundles). More...
 
core::Size copy_from_parameters_index () const
 Get the index of the Parameters object from which we will copy this parameter's value. More...
 
bool value_was_set () const
 Has the value been set? More...
 
bool copying_information_was_set () const
 Has the copying information been set? More...
 
void set_parameter_name (std::string const &name_in)
 Set parameter name. More...
 
void set_parameter_description (std::string const &description_in)
 Set parameter description. More...
 
void set_short_parameter_description (std::string const &short_description_in)
 Set short parameter description. More...
 
void set_parameter_units (std::string const &units_in)
 Set parameter units. More...
 
void set_can_be_set_sampled_perturbed_copied (bool const can_be_set, bool const can_be_copied, bool const can_be_sampled, bool const can_be_perturbed)
 Set whether this parameter is one that can be set directly by the user, whether it can be sampled, and whether it can be perturbed. More...
 
void set_global_for_parameters_set (bool const setting)
 Set whether this property is meant to be global for a parameters set. More...
 
void set_copy_suffix (std::string const &suffix_in)
 Set the suffix for the copy tag (e.g. "copies_helix" in the case of helical bundles). More...
 
void set_copy_from_parameters_index (core::Size const setting)
 Set the index of the Parameters object from which we will copy this parameter's value. More...
 
virtual void reset_copying_settings ()
 Reset the copying options. More...
 

Private Member Functions

void correct_values ()
 If this is a parameter storing an angle, correct the value to be (-Pi:Pi]. If it is supposed to be nonnegative, or nonzero/positive throw an error if it is not. More...
 

Private Attributes

utility::vector1< core::Realvalues_
 The vector of values for this parameter. More...
 
utility::vector1< core::Realdefault_value_
 The default values for this parameter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from core::conformation::parametric::Parameter
void set_value_was_set ()
 Allows derived classes to indicate that the value has been set. More...
 
void reset_value_was_set ()
 Allows derived classes to indicate that the value has not been set. More...
 

Detailed Description

RealVectorValuedParameter class, used to store a single vector-valued parameter for parametric backbone generation.

Constructor & Destructor Documentation

core::conformation::parametric::RealVectorValuedParameter::RealVectorValuedParameter ( )
core::conformation::parametric::RealVectorValuedParameter::RealVectorValuedParameter ( RealVectorValuedParameter const &  src)
core::conformation::parametric::RealVectorValuedParameter::~RealVectorValuedParameter ( )
override

Member Function Documentation

ParameterOP core::conformation::parametric::RealVectorValuedParameter::clone ( ) const
overridevirtual

Make a copy of this object ( allocate actual memory for it )

Implements core::conformation::parametric::Parameter.

bool core::conformation::parametric::RealVectorValuedParameter::copy_value_from_parameter ( ParameterCOP  other_parameter,
ParametersCOP  other_parameter_collection,
ParametersCOP  this_parameter_collection 
)
overridevirtual

Given another parameter of the same type, copy its value. This does not set value_set_ to true.

Performs type checking in debug mode.

Implements core::conformation::parametric::Parameter.

References values_.

void core::conformation::parametric::RealVectorValuedParameter::correct_values ( )
private

If this is a parameter storing an angle, correct the value to be (-Pi:Pi]. If it is supposed to be nonnegative, or nonzero/positive throw an error if it is not.

References core::conformation::parametric::Parameter::parameter_type(), core::conformation::parametric::PT_angle_vector, core::conformation::parametric::PT_generic_nonnegative_valued_real_vector, core::conformation::parametric::PT_generic_positive_valued_real_vector, and values_.

Referenced by set_parameter_type(), and set_value().

utility::vector1< core::Real > const& core::conformation::parametric::RealVectorValuedParameter::default_value ( ) const
inline

Get the defaults for this parameter.

References default_value_.

Referenced by reset_value_settings().

void core::conformation::parametric::RealVectorValuedParameter::parse_setting ( utility::tag::TagCOP  tag,
bool const  parse_setting,
bool const  parse_grid_sampling,
bool const  parse_perturbation,
bool const  parse_copying 
)
overridevirtual

Given a tag, parse out the setting for this parameter.

If parse_setting is true, this tries to parse the value for this parameter. If parse_grid_sampling is true, this tries to parse a range of values to sample, and a number of samples. If parse_perturbation is true, this parses options for perturbing the value of the parameter. Note that, if multiple options are true, grid sampling or perturbation options are given priority over a flat setting (and an error is thrown if more than one of these is provided).

Note
A vector of floats must be provided as a whitespace-separated string.

Implements core::conformation::parametric::Parameter.

References core::conformation::parametric::Parameter::parameter_name(), set_value(), and protocols::hybridization::val.

void core::conformation::parametric::RealVectorValuedParameter::provide_xsd_information ( utility::tag::AttributeList &  xsd,
bool const  provide_setting,
bool const  ,
bool const  ,
bool const   
) const
overridevirtual

Return the XSD information for this parameter.

Note
Currently, RealVector-valued parameters can't be sampled or perturbed, so this only provides setting information.

Implements core::conformation::parametric::Parameter.

References default_value_, core::conformation::parametric::Parameter::parameter_description(), and core::conformation::parametric::Parameter::parameter_name().

void core::conformation::parametric::RealVectorValuedParameter::reset_sampling_and_perturbation_settings ( )
overridevirtual

Reset the sampling and perturbation options before storing this Parameter object in a parametric Conformation.

Pure virtual. Must be implemented by derived classes.

Implements core::conformation::parametric::Parameter.

void core::conformation::parametric::RealVectorValuedParameter::reset_value_settings ( )
overridevirtual
void core::conformation::parametric::RealVectorValuedParameter::set_default_value ( utility::vector1< core::Real > const &  value_in)

Set the default value for this parameter.

References default_value_, core::conformation::parametric::Parameter::value_was_set(), and values_.

void core::conformation::parametric::RealVectorValuedParameter::set_parameter_type ( ParameterType const  type_in)
overridevirtual
void core::conformation::parametric::RealVectorValuedParameter::set_value ( utility::vector1< core::Real > const &  value_in)
utility::vector1< core::Real > const& core::conformation::parametric::RealVectorValuedParameter::value ( ) const
inline

Get the value of this parameter.

References values_.

Member Data Documentation

utility::vector1< core::Real > core::conformation::parametric::RealVectorValuedParameter::default_value_
private

The default values for this parameter.

Referenced by default_value(), provide_xsd_information(), and set_default_value().

utility::vector1< core::Real > core::conformation::parametric::RealVectorValuedParameter::values_
private

The vector of values for this parameter.

Referenced by copy_value_from_parameter(), correct_values(), set_default_value(), set_value(), and value().


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