Rosetta 3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | Friends | List of all members
protocols::id::AlignmentID Class Reference

Unique template identifier class. More...

#include <AlignmentID.hh>

Collaboration diagram for protocols::id::AlignmentID:
Collaboration graph
[legend]

Public Member Functions

 AlignmentID ()
 Default constructor. More...
 
 AlignmentID (AlignmentID const &src)
 Copy constructor. More...
 
 AlignmentID (core::Size const align_idx_in, std::string const template_name_in)
 Property constructor. More...
 
std::string template_name () const
 
std::string & template_name ()
 
core::Size align_idx () const
 
core::Sizealign_idx ()
 
void template_name (std::string const &name)
 
void align_idx (core::Size const &idx)
 
bool valid () const
 Is this id valid? More...
 
std::string to_string () const
 

Private Attributes

core::Size align_idx_
 numerical identifier for Nth alignment to this template More...
 
std::string template_name_
 template name More...
 

Friends

std::ostream & operator<< (std::ostream &os, AlignmentID const &a)
 
std::istream & operator>> (std::istream &is, AlignmentID &a)
 
bool operator== (AlignmentID const &a, AlignmentID const &b)
 a and b are the same atom More...
 
bool operator!= (AlignmentID const &a, AlignmentID const &b)
 a and b are different atom More...
 
bool operator< (AlignmentID const &a, AlignmentID const &b)
 a is LOWER than b (e.g., first by smaller template name then by smaller alignment index) More...
 

Detailed Description

Unique template identifier class.

Constructor & Destructor Documentation

protocols::id::AlignmentID::AlignmentID ( )
inline

Default constructor.

protocols::id::AlignmentID::AlignmentID ( AlignmentID const &  src)
inline

Copy constructor.

protocols::id::AlignmentID::AlignmentID ( core::Size const  align_idx_in,
std::string const  template_name_in 
)
inline

Property constructor.

Member Function Documentation

core::Size protocols::id::AlignmentID::align_idx ( ) const
inline

References align_idx_.

Referenced by to_string().

core::Size& protocols::id::AlignmentID::align_idx ( )
inline

References align_idx_.

void protocols::id::AlignmentID::align_idx ( core::Size const &  idx)
inline

References align_idx_.

std::string protocols::id::AlignmentID::template_name ( ) const
inline

References template_name_.

Referenced by to_string().

std::string& protocols::id::AlignmentID::template_name ( )
inline

References template_name_.

void protocols::id::AlignmentID::template_name ( std::string const &  name)
inline

References template_name_.

std::string protocols::id::AlignmentID::to_string ( ) const
inline

References align_idx(), and template_name().

bool protocols::id::AlignmentID::valid ( ) const
inline

Is this id valid?

References align_idx_, and template_name_.

Friends And Related Function Documentation

bool operator!= ( AlignmentID const &  a,
AlignmentID const &  b 
)
friend

a and b are different atom

bool operator< ( AlignmentID const &  a,
AlignmentID const &  b 
)
friend

a is LOWER than b (e.g., first by smaller template name then by smaller alignment index)

std::ostream& operator<< ( std::ostream &  os,
AlignmentID const &  a 
)
friend
bool operator== ( AlignmentID const &  a,
AlignmentID const &  b 
)
friend

a and b are the same atom

std::istream& operator>> ( std::istream &  is,
AlignmentID a 
)
friend

Member Data Documentation

core::Size protocols::id::AlignmentID::align_idx_
private

numerical identifier for Nth alignment to this template

Referenced by align_idx(), and valid().

std::string protocols::id::AlignmentID::template_name_
private

template name

Referenced by template_name(), and valid().


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