CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::DoF::RemoteHandle Class Reference

#include <DoF.hh>

Detailed Description

A RemoteHandle can be initialized with either a double or integer reference and then passed to a DoF (or to a BasisFunction, which contains DoFs), in order for the DoF to access the remote value

Definition at line 42 of file DoF.hh.

Public Member Functions

 RemoteHandle (std::string const &_type_name, std::string const &_var_name, Index _dof_ID)
 
RemoteHandleoperator= (double const &d)
 
RemoteHandleoperator= (int const &i)
 
RemoteHandleoperator= (double &&d)=delete
 
RemoteHandleoperator= (int &&i)=delete
 
bool operator< (RemoteHandle const &_rhs) const
 
bool operator== (RemoteHandle const &_rhs) const
 
const int * i_ptr () const
 
const double * d_ptr () const
 

Private Attributes

double const * m_d_ptr
 
int const * m_i_ptr
 
std::string m_type_name
 
std::string m_var_name
 
Index m_dof_ID
 

Constructor & Destructor Documentation

◆ RemoteHandle()

CASM::DoF::RemoteHandle::RemoteHandle ( std::string const &  _type_name,
std::string const &  _var_name,
Index  _dof_ID 
)
inline

Definition at line 45 of file DoF.hh.

Member Function Documentation

◆ d_ptr()

const double* CASM::DoF::RemoteHandle::d_ptr ( ) const
inline

Definition at line 88 of file DoF.hh.

◆ i_ptr()

const int* CASM::DoF::RemoteHandle::i_ptr ( ) const
inline

Definition at line 85 of file DoF.hh.

◆ operator<()

bool CASM::DoF::RemoteHandle::operator< ( RemoteHandle const &  _rhs) const
inline

Definition at line 70 of file DoF.hh.

◆ operator=() [1/4]

RemoteHandle& CASM::DoF::RemoteHandle::operator= ( double &&  d)
delete

◆ operator=() [2/4]

RemoteHandle& CASM::DoF::RemoteHandle::operator= ( double const &  d)
inline

Definition at line 50 of file DoF.hh.

◆ operator=() [3/4]

RemoteHandle& CASM::DoF::RemoteHandle::operator= ( int &&  i)
delete

◆ operator=() [4/4]

RemoteHandle& CASM::DoF::RemoteHandle::operator= ( int const &  i)
inline

Definition at line 57 of file DoF.hh.

◆ operator==()

bool CASM::DoF::RemoteHandle::operator== ( RemoteHandle const &  _rhs) const
inline

Definition at line 79 of file DoF.hh.

Member Data Documentation

◆ m_d_ptr

double const* CASM::DoF::RemoteHandle::m_d_ptr
private

Definition at line 91 of file DoF.hh.

◆ m_dof_ID

Index CASM::DoF::RemoteHandle::m_dof_ID
private

Definition at line 96 of file DoF.hh.

◆ m_i_ptr

int const* CASM::DoF::RemoteHandle::m_i_ptr
private

Definition at line 92 of file DoF.hh.

◆ m_type_name

std::string CASM::DoF::RemoteHandle::m_type_name
private

Definition at line 94 of file DoF.hh.

◆ m_var_name

std::string CASM::DoF::RemoteHandle::m_var_name
private

Definition at line 95 of file DoF.hh.


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