protocols::loophash::LoopHashLibraryOptions Class Reference

LoopHashLibraryOptions encapsulates the options associated with LoopHashLibrary resources. More...

#include <LoopHashLibraryOptions.hh>

Inheritance diagram for protocols::loophash::LoopHashLibraryOptions:

Public Member Functions
	LoopHashLibraryOptions ()
	Construct the LoopHashLibraryOptions. More...
virtual	~LoopHashLibraryOptions ()
	Destructor. More...
virtual void	parse_my_tag (utility::tag::TagCOP tag)
	Read the configuration of the LoopHashLibrary resource from the tag generated from the resource definition file. More...
virtual std::string	type () const
	Return the name of this class (LoopHashLibraryOptions). More...
utility::vector1< core::Size >	loop_sizes () const
	Return a vector of loop sizes that will be used to construct a LoopHashLibrary. More...
void	loop_sizes (utility::vector1< core::Size > loop_sizes)
	Set the loop sizes that will be used to construct a LoopHashLibrary to a vector of loop lengths. More...

Private Attributes
utility::vector1< core::Size >	loop_sizes_
	Vector of Sizes that stores the loop lengths that will be used to construct a LoopHashLibrary. More...

Detailed Description

LoopHashLibraryOptions encapsulates the options associated with LoopHashLibrary resources.

These options are read in from a resource definition file and each LoopHashLibrary resource has a corresponding LoopHashLibraryOptions instance.

Constructor & Destructor Documentation

protocols::loophash::LoopHashLibraryOptions::LoopHashLibraryOptions

(

)

Construct the LoopHashLibraryOptions.

protocols::loophash::LoopHashLibraryOptions::~LoopHashLibraryOptions ( )

virtual

Destructor.

Member Function Documentation

utility::vector1< core::Size > protocols::loophash::LoopHashLibraryOptions::loop_sizes

(

)

const

Return a vector of loop sizes that will be used to construct a LoopHashLibrary.

References loop_sizes_.

Referenced by protocols::loophash::LoopHashLibraryLoader::create_resource(), and loop_sizes().

void protocols::loophash::LoopHashLibraryOptions::loop_sizes

(

utility::vector1< core::Size >

loop_sizes

)

Set the loop sizes that will be used to construct a LoopHashLibrary to a vector of loop lengths.

References loop_sizes(), and loop_sizes_.

void protocols::loophash::LoopHashLibraryOptions::parse_my_tag ( utility::tag::TagCOP  tag )

virtual

Read the configuration of the LoopHashLibrary resource from the tag generated from the resource definition file.

Read the resource definitions file's tag and parse the loop_sizes option to generate a vector of valid loops lenths that will be used to generate a LoopHashLibrary. If this option is omitted execution is halted and a helpful error message is displayed to the user.

References loop_sizes_.

std::string protocols::loophash::LoopHashLibraryOptions::type ( ) const

virtual

Return the name of this class (LoopHashLibraryOptions).

Return the string value for the name of this class (LoopHashLibraryOptions).

Member Data Documentation

utility::vector1<core::Size> protocols::loophash::LoopHashLibraryOptions::loop_sizes_

private

Vector of Sizes that stores the loop lengths that will be used to construct a LoopHashLibrary.

Referenced by loop_sizes(), and parse_my_tag().

---

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

• src/protocols/loophash/LoopHashLibraryOptions.hh
• src/protocols/loophash/LoopHashLibraryOptions.cc