CASM::ClexParamKey Class Reference

#include <ClexParamPack.hh>

Detailed Description

Key for indexing clexulator parameters Contains pointer to implementation of the Key.

Definition at line 181 of file ClexParamPack.hh.

Public Member Functions
	ClexParamKey ()
	Allow default construction. More...
	ClexParamKey (ClexParamPack_impl::BaseKey const &_key)
	Construct ClexParamKey by cloning specialization of BaseKey. More...
std::string const &	name () const
	Returns name of key. More...
ClexParamPack_impl::BaseKey const *	ptr () const
	Returns pointer to Key implementation. More...
template<typename... Args>
ClexParamKey &	operator() (Args const &... args)
	use parentheses operator to set identifiers. Permits syntax like More...

Private Attributes
notstd::cloneable_ptr< ClexParamPack_impl::BaseKey >	m_key_ptr
	ptr to BaseKey class that hides implementation-specific access attributes More...

Constructor & Destructor Documentation

ClexParamKey() [1/2]

CASM::ClexParamKey::ClexParamKey ( )

inline

Allow default construction.

Definition at line 184 of file ClexParamPack.hh.

ClexParamKey() [2/2]

CASM::ClexParamKey::ClexParamKey ( ClexParamPack_impl::BaseKey const &  _key )

inline

Construct ClexParamKey by cloning specialization of BaseKey.

Definition at line 187 of file ClexParamPack.hh.

Member Function Documentation

name()

std::string const& CASM::ClexParamKey::name ( ) const

inline

Returns name of key.

Definition at line 191 of file ClexParamPack.hh.

operator()()

template<typename... Args>

ClexParamKey& CASM::ClexParamKey::operator() ( Args const &...  args )

inline

use parentheses operator to set identifiers. Permits syntax like

ClexParamPack * pp_ptr = &(my_clexulator.param_pack());
ClexParamKey pp_ptr->key("some_inherently_5dimensional_parameter");
// accesses slice of 5-dimensional data
Eigen::MatrixXd my_params = pp_ptr->read(key(i,
std::pair<Index,Index>(j,k)));

Definition at line 208 of file ClexParamPack.hh.

ptr()

ClexParamPack_impl::BaseKey const* CASM::ClexParamKey::ptr ( ) const

inline

Returns pointer to Key implementation.

Definition at line 194 of file ClexParamPack.hh.

Member Data Documentation

m_key_ptr

notstd::cloneable_ptr<ClexParamPack_impl::BaseKey> CASM::ClexParamKey::m_key_ptr

private

ptr to BaseKey class that hides implementation-specific access attributes

Definition at line 216 of file ClexParamPack.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ClexParamPack.hh