Rosetta
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
core::id::StubID Class Reference

#include <AtomID.hh>

Public Member Functions

 StubID (AtomID const &a1, AtomID const &a2, AtomID const &a3)
 
 StubID (AtomID const &c, AtomID const &a1, AtomID const &a2, AtomID const &a3)
 
constexpr StubID ()
 
AtomID const & atom (Size const index) const
 
AtomID const & center () const
 
bool valid () const
 
bool operator== (StubID const &rhs) const
 
bool operator!= (StubID const &rhs) const
 

Static Public Member Functions

static constexpr StubID const BOGUS_STUB_ID ()
 

Public Attributes

AtomID atom1
 
AtomID atom2
 
AtomID atom3
 
AtomID center_
 

Friends

bool operator< (StubID const &a, StubID const &b)
 
std::ostream & operator<< (std::ostream &os, StubID const &)
 stream << AtomID More...
 

Constructor & Destructor Documentation

◆ StubID() [1/3]

core::id::StubID::StubID ( AtomID const &  a1,
AtomID const &  a2,
AtomID const &  a3 
)
inline

◆ StubID() [2/3]

core::id::StubID::StubID ( AtomID const &  c,
AtomID const &  a1,
AtomID const &  a2,
AtomID const &  a3 
)
inline

◆ StubID() [3/3]

constexpr core::id::StubID::StubID ( )
inlineconstexpr

Referenced by BOGUS_STUB_ID().

Member Function Documentation

◆ atom()

AtomID const& core::id::StubID::atom ( Size const  index) const
inline

◆ BOGUS_STUB_ID()

static constexpr StubID const core::id::StubID::BOGUS_STUB_ID ( )
inlinestaticconstexpr

References StubID().

◆ center()

AtomID const& core::id::StubID::center ( ) const
inline

◆ operator!=()

bool core::id::StubID::operator!= ( StubID const &  rhs) const

◆ operator==()

bool core::id::StubID::operator== ( StubID const &  rhs) const

References atom1, atom2, atom3, and center_.

◆ valid()

bool core::id::StubID::valid ( ) const
inline

Friends And Related Function Documentation

◆ operator<

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

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
StubID const &  stub 
)
friend

stream << AtomID

Member Data Documentation

◆ atom1

AtomID core::id::StubID::atom1

◆ atom2

AtomID core::id::StubID::atom2

◆ atom3

AtomID core::id::StubID::atom3

◆ center_

AtomID core::id::StubID::center_

Referenced by center(), operator==(), and valid().


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