FFAtom Class Reference

#include <indigox/classes/forcefield.hpp>

Public Member Functions
	FFAtom ()=default
	FFAtom (const FFAtom &)=default
	FFAtom (FFAtom &&)=default
	~ FFAtom ()=default
Element	GetElement () const
Forcefield	GetForcefield () const
int32_t	GetID () const
	Get the ID for this type. More...
std::string	GetName () const
	Get the name for this type. More...
	operator bool () const
bool	operator!= (const FFAtom &atm) const
bool	operator< (const FFAtom &atm) const
bool	operator<= (const FFAtom &atm) const
FFAtom &	operator= (const FFAtom &)=default
FFAtom &	operator= (FFAtom &&)=default
bool	operator== (const FFAtom &atm) const
bool	operator> (const FFAtom &atm) const
bool	operator>= (const FFAtom &atm) const

Friends
class	cereal::access
	Friendship allows serialisation. More...
class	Forcefield
	Friendship allows atom types to be added to a forcefield. More...
std::ostream &	operator<< (std::ostream &os, const FFAtom &atm)

Constructor & Destructor Documentation

FFAtom() [1/3]

FFAtom ( )

default

FFAtom() [2/3]

FFAtom ( const FFAtom &  )

default

FFAtom() [3/3]

FFAtom ( FFAtom &&  )

default

~ FFAtom()

~ FFAtom ( )

default

Member Function Documentation

GetElement()

Element GetElement

(

)

const

GetForcefield()

Forcefield GetForcefield

(

)

const

GetID()

int32_t GetID

(

)

const

Get the ID for this type.

Returns

the ID of this atom type.

GetName()

std::string GetName

(

)

const

Get the name for this type.

Returns

the name of this atom type.

operator bool()

operator bool ( ) const

inline

operator!=()

bool operator!= ( const FFAtom &  atm ) const

inline

operator<()

bool operator<

(

const FFAtom &

atm

)

const

operator<=()

bool operator<= ( const FFAtom &  atm ) const

inline

operator=() [1/2]

FFAtom& operator= ( FFAtom &&  )

default

operator=() [2/2]

FFAtom& operator= ( const FFAtom &  )

default

operator==()

bool operator==

(

const FFAtom &

atm

)

const

operator>()

bool operator>

(

const FFAtom &

atm

)

const

operator>=()

bool operator>= ( const FFAtom &  atm ) const

inline

Friends And Related Function Documentation

cereal::access

friend class cereal::access

friend

Friendship allows serialisation.

Forcefield

friend class Forcefield

friend

Friendship allows atom types to be added to a forcefield.

operator<<

std::ostream& operator<< ( std::ostream &  os, const FFAtom &  atm  )

friend

---

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

• include/indigox/classes/forcefield.hpp