#include <CompositionAxes.hh>

Detailed Description

Data structure to facilitate reading, writing, selecting composition axes in a CASM project

Definition at line 14 of file CompositionAxes.hh.

Public Member Functions
	CompositionAxes ()

template<typename IterType >
void	insert_enumerated (IterType begin, IterType end)
	Iterate over list of CompositionConverter and insert each one as an enumerated axes set with a unique numerical name. More...

void	erase_enumerated ()
	Erase all enumerated axes and clear this->enumerated. More...

void	select (std::string key)
	Set this->curr using key. More...

bool	has_current_axes () const
	True if curr_key is set. More...

Public Attributes
std::map< std::string, CompositionConverter >	all_axes

std::set< std::string >	enumerated

std::string	curr_key

CompositionConverter	curr

int	err_code = 0

std::string	err_message

Constructor & Destructor Documentation

◆ CompositionAxes()

CASM::CompositionAxes::CompositionAxes ( )

inline

Definition at line 15 of file CompositionAxes.hh.

Member Function Documentation

◆ erase_enumerated()

void CASM::CompositionAxes::erase_enumerated ( )

Erase all enumerated axes and clear this->enumerated.

Definition at line 6 of file CompositionAxes.cc.

◆ has_current_axes()

bool CASM::CompositionAxes::has_current_axes ( ) const

inline

True if curr_key is set.

Definition at line 29 of file CompositionAxes.hh.

◆ insert_enumerated()

template<typename IterType >

void CASM::CompositionAxes::insert_enumerated	(	IterType	begin,
		IterType	end
	)

Iterate over list of CompositionConverter and insert each one as an enumerated axes set with a unique numerical name.

Definition at line 9 of file CompositionAxes_impl.hh.

◆ select()

void CASM::CompositionAxes::select ( std::string key )

Set this->curr using key.

Definition at line 15 of file CompositionAxes.cc.

Member Data Documentation

◆ all_axes

std::map<std::string, CompositionConverter> CASM::CompositionAxes::all_axes

Definition at line 31 of file CompositionAxes.hh.

◆ curr

CompositionConverter CASM::CompositionAxes::curr

Definition at line 34 of file CompositionAxes.hh.

◆ curr_key

std::string CASM::CompositionAxes::curr_key

Definition at line 33 of file CompositionAxes.hh.

◆ enumerated

std::set<std::string> CASM::CompositionAxes::enumerated

Definition at line 32 of file CompositionAxes.hh.

◆ err_code

int CASM::CompositionAxes::err_code = 0

Definition at line 36 of file CompositionAxes.hh.

◆ err_message

std::string CASM::CompositionAxes::err_message

Definition at line 37 of file CompositionAxes.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/CompositionAxes.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/CompositionAxes_impl.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/clex/CompositionAxes.cc