Rosetta  2020.37
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
protocols::matdes::GetRBDOFValues Class Reference

WARNING WARNING WARNING THIS CLASS USES THE THREAD UNSAFE SymDofMoverSampler AND MAKES ANY PROTOCOL THAT USES THIS CLASS THREAD UNSAFE. More...

#include <GetRBDOFValues.hh>

Inheritance diagram for protocols::matdes::GetRBDOFValues:
Inheritance graph
[legend]

Public Types

typedef protocols::filters::Filter Super
 
typedef protocols::filters::Filter Filter
 
typedef
protocols::filters::FilterOP 
FilterOP
 
typedef core::Real Real
 
typedef core::pose::Pose Pose
 
typedef utility::tag::TagCOP TagCOP
 
typedef basic::datacache::DataMap DataMap
 

Public Member Functions

 GetRBDOFValues ()
 
 GetRBDOFValues (int jump, std::string const &dof_name, bool verb, char ax, bool disp, bool ang, core::Real init_d, core::Real init_a, bool get_init)
 
 GetRBDOFValues (GetRBDOFValues const &rval)
 
 ~GetRBDOFValues () override
 
protocols::filters::FilterOP clone () const override
 
protocols::filters::FilterOP fresh_instance () const override
 
void jump_id (core::Size const jump)
 
void sym_dof_name (std::string const &dof_name)
 
void verbose (bool const verb)
 
void axis (char const ax)
 
void radial_disp (bool const disp)
 
void angle (bool const ang)
 
void init_disp (core::Real const init_d)
 
void init_angle (core::Real const init_a)
 
void get_init_value (bool const get_init)
 
core::Size jump_id () const
 
std::string sym_dof_name () const
 
bool verbose () const
 
char axis () const
 
bool radial_disp () const
 
bool angle () const
 
core::Real init_disp () const
 
core::Real init_angle () const
 
bool get_init_value () const
 
void parse_my_tag (TagCOP tag, basic::datacache::DataMap &) override
 parse xml More...
 
bool apply (Pose const &pose) const override
 Returns true if the given pose passes the filter, false otherwise. More...
 
core::Real report_sm (Pose const &pose) const override
 used to report filter internals through a score or silent file More...
 
void report (std::ostream &out, Pose const &pose) const override
 
core::Real compute (Pose const &pose, bool const &verb, std::string const &dof_name, int const &jump, char const &ax, bool const &disp, bool const &ang, core::Real const &init_d, core::Real const &init_a, bool const &get_init) const
 get the translation and rotation for a user specified jump More...
 
std::string name () const override
 
- Public Member Functions inherited from protocols::filters::Filter
 Filter ()
 
 Filter (std::string const &)
 
 Filter (Filter const &)
 
 ~Filter () override
 
virtual std::string get_type () const
 
std::string get_user_defined_name () const
 
void set_user_defined_name (std::string const &name)
 
virtual void clear ()
 used to clear internal variables if needed. Using fresh_instance is preferred since it's a pure virtual More...
 
virtual core::Real score (core::pose::Pose &pose)
 
virtual bool filter_provides_citation_info () const
 Does this filter provide information about how to cite it? More...
 
virtual utility::vector1
< basic::citation_manager::CitationCollectionCOP > 
provide_citation_info () const
 Provide the citation. More...
 
virtual bool filter_is_unpublished () const
 Does this filter indicate that it is unpublished (and, by extension, that the author should be included in publications resulting from it)? More...
 
virtual utility::vector1
< basic::citation_manager::UnpublishedModuleInfoCOP > 
provide_authorship_info_for_unpublished () const
 Provide a list of authors and their e-mail addresses, as strings. More...
 

Static Public Member Functions

static std::string class_name ()
 
static void provide_xml_schema (utility::tag::XMLSchemaDefinition &xsd)
 

Private Attributes

int jump_id_
 
std::string sym_dof_name_
 
bool verbose_
 
bool radial_disp_
 
bool angle_
 
bool get_init_value_
 
char axis_
 
core::Real init_disp_
 
core::Real init_angle_
 

Additional Inherited Members

- Protected Attributes inherited from protocols::filters::Filter
std::string scorename_
 

Detailed Description

WARNING WARNING WARNING THIS CLASS USES THE THREAD UNSAFE SymDofMoverSampler AND MAKES ANY PROTOCOL THAT USES THIS CLASS THREAD UNSAFE.

Member Typedef Documentation

typedef basic::datacache::DataMap protocols::matdes::GetRBDOFValues::DataMap
typedef utility::tag::TagCOP protocols::matdes::GetRBDOFValues::TagCOP

Constructor & Destructor Documentation

protocols::matdes::GetRBDOFValues::GetRBDOFValues ( )
protocols::matdes::GetRBDOFValues::GetRBDOFValues ( int  jump,
std::string const &  dof_name,
bool  verb,
char  ax,
bool  disp,
bool  ang,
core::Real  init_d,
core::Real  init_a,
bool  get_init 
)
protocols::matdes::GetRBDOFValues::GetRBDOFValues ( GetRBDOFValues const &  rval)
default
protocols::matdes::GetRBDOFValues::~GetRBDOFValues ( )
overridedefault

Member Function Documentation

void protocols::matdes::GetRBDOFValues::angle ( bool const  ang)

References angle_.

bool protocols::matdes::GetRBDOFValues::angle ( ) const

References angle_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

bool protocols::matdes::GetRBDOFValues::apply ( Pose const &  pose) const
overridevirtual

Returns true if the given pose passes the filter, false otherwise.

Implements protocols::filters::Filter.

References angle(), axis(), compute(), get_init_value(), init_angle(), init_disp(), jump_id(), radial_disp(), sym_dof_name(), and verbose().

void protocols::matdes::GetRBDOFValues::axis ( char const  ax)

References axis_.

char protocols::matdes::GetRBDOFValues::axis ( ) const

References axis_.

Referenced by apply(), compute(), parse_my_tag(), report(), and report_sm().

std::string protocols::matdes::GetRBDOFValues::class_name ( )
static
protocols::filters::FilterOP protocols::matdes::GetRBDOFValues::clone ( ) const
overridevirtual
core::Real protocols::matdes::GetRBDOFValues::compute ( Pose const &  pose,
bool const &  verb,
std::string const &  dof_name,
int const &  jump,
char const &  ax,
bool const &  disp,
bool const &  ang,
core::Real const &  init_d,
core::Real const &  init_a,
bool const &  get_init 
) const
protocols::filters::FilterOP protocols::matdes::GetRBDOFValues::fresh_instance ( ) const
overridevirtual
void protocols::matdes::GetRBDOFValues::get_init_value ( bool const  get_init)

References get_init_value_.

bool protocols::matdes::GetRBDOFValues::get_init_value ( ) const

References get_init_value_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

void protocols::matdes::GetRBDOFValues::init_angle ( core::Real const  init_a)

References init_angle_.

core::Real protocols::matdes::GetRBDOFValues::init_angle ( ) const

References init_angle_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

void protocols::matdes::GetRBDOFValues::init_disp ( core::Real const  init_d)

References init_disp_.

core::Real protocols::matdes::GetRBDOFValues::init_disp ( ) const

References init_disp_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

void protocols::matdes::GetRBDOFValues::jump_id ( core::Size const  jump)

References jump_id_.

core::Size protocols::matdes::GetRBDOFValues::jump_id ( ) const

References jump_id_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

std::string protocols::matdes::GetRBDOFValues::name ( ) const
overridevirtual

Reimplemented from protocols::filters::Filter.

References class_name().

void protocols::matdes::GetRBDOFValues::parse_my_tag ( TagCOP  tag,
basic::datacache::DataMap &   
)
overridevirtual
void protocols::matdes::GetRBDOFValues::provide_xml_schema ( utility::tag::XMLSchemaDefinition &  xsd)
static
void protocols::matdes::GetRBDOFValues::radial_disp ( bool const  disp)

References radial_disp_.

bool protocols::matdes::GetRBDOFValues::radial_disp ( ) const

References radial_disp_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

void protocols::matdes::GetRBDOFValues::report ( std::ostream &  out,
Pose const &  pose 
) const
overridevirtual
core::Real protocols::matdes::GetRBDOFValues::report_sm ( Pose const &  ) const
overridevirtual

used to report filter internals through a score or silent file

Reimplemented from protocols::filters::Filter.

References angle(), axis(), compute(), get_init_value(), init_angle(), init_disp(), jump_id(), radial_disp(), and sym_dof_name().

void protocols::matdes::GetRBDOFValues::sym_dof_name ( std::string const &  dof_name)

References sym_dof_name_.

std::string protocols::matdes::GetRBDOFValues::sym_dof_name ( ) const

References sym_dof_name_.

Referenced by apply(), parse_my_tag(), report(), and report_sm().

void protocols::matdes::GetRBDOFValues::verbose ( bool const  verb)

References verbose_.

bool protocols::matdes::GetRBDOFValues::verbose ( ) const

References verbose_.

Referenced by apply(), and parse_my_tag().

Member Data Documentation

bool protocols::matdes::GetRBDOFValues::angle_
private

Referenced by angle().

char protocols::matdes::GetRBDOFValues::axis_
private

Referenced by axis().

bool protocols::matdes::GetRBDOFValues::get_init_value_
private

Referenced by get_init_value().

core::Real protocols::matdes::GetRBDOFValues::init_angle_
private

Referenced by init_angle().

core::Real protocols::matdes::GetRBDOFValues::init_disp_
private

Referenced by init_disp().

int protocols::matdes::GetRBDOFValues::jump_id_
private

Referenced by jump_id().

bool protocols::matdes::GetRBDOFValues::radial_disp_
private

Referenced by radial_disp().

std::string protocols::matdes::GetRBDOFValues::sym_dof_name_
private

Referenced by sym_dof_name().

bool protocols::matdes::GetRBDOFValues::verbose_
private

Referenced by verbose().


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