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

#include <BooleanValuedParameter.hh>

Inheritance diagram for core::conformation::parametric::BooleanValuedParameter:

[legend]

Public Member Functions
	BooleanValuedParameter ()
	constructors More...

	BooleanValuedParameter (BooleanValuedParameter const &src)

	~BooleanValuedParameter () override

ParameterOP	clone () const override
	Make a copy of this object ( allocate actual memory for it ) More...

bool	value () const
	Get the value of this parameter. More...

bool	default_value () const
	Get the default value of this parameter. More...

void	set_value (bool 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 (bool const value_in)
	Set the default value of 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 provide_copying, bool const provide_grid_sampling, bool const provide_perturbation) 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 Attributes
bool	value_
	The value of this parameter. More...

bool	default_value_
	The default value of 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

BooleanValuedParameter class, used to store a single Boolean-valued parameter for parametric backbone generation.

Constructor & Destructor Documentation

core::conformation::parametric::BooleanValuedParameter::BooleanValuedParameter ( )

constructors

Constructor.

References core::conformation::parametric::PT_boolean, core::conformation::parametric::Parameter::set_can_be_set_sampled_perturbed_copied(), and core::conformation::parametric::Parameter::set_parameter_type().

core::conformation::parametric::BooleanValuedParameter::BooleanValuedParameter ( BooleanValuedParameter const & src )

core::conformation::parametric::BooleanValuedParameter::~BooleanValuedParameter ( )

override

Member Function Documentation

ParameterOP core::conformation::parametric::BooleanValuedParameter::clone ( ) const

overridevirtual

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

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

bool core::conformation::parametric::BooleanValuedParameter::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 value_.

bool core::conformation::parametric::BooleanValuedParameter::default_value ( ) const

inline

Get the default value of this parameter.

References default_value_.

Referenced by provide_xsd_information(), and reset_value_settings().

void core::conformation::parametric::BooleanValuedParameter::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: Must be implemented by derived classes.

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

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

void core::conformation::parametric::BooleanValuedParameter::provide_xsd_information	(	utility::tag::AttributeList &	xsd,
		bool const	provide_setting,
		bool const	provide_copying,
		bool const	provide_grid_sampling,
		bool const	provide_perturbation
	)		const