Flow123d  master-f44eb46
Public Member Functions | Private Attributes | List of all members
SubstanceList Class Reference

#include <substance.hh>

Public Member Functions

void initialize (const Input::Array &in_array)
 Read from input array. More...
 
void initialize (SubstanceList &list)
 Bind to existing list. More...
 
void initialize (const std::vector< std::string > &names)
 Construct from a list of names. More...
 
const Substanceoperator[] (unsigned int index)
 
const std::vector< std::string > & names ()
 
unsigned int size () const
 

Private Attributes

std::shared_ptr< std::vector< Substance > > substances_
 The actual list of substances. More...
 
std::shared_ptr< std::vector< std::string > > names_
 Auxiliary list of substance names used in some classes. More...
 

Detailed Description

SubstanceList is an envelope around a vector of substances, which provides some additional functionality such as:

Definition at line 70 of file substance.hh.

Member Function Documentation

◆ initialize() [1/3]

void SubstanceList::initialize ( const Input::Array in_array)

Read from input array.

Definition at line 58 of file substance.cc.

Here is the caller graph for this function:

◆ initialize() [2/3]

void SubstanceList::initialize ( const std::vector< std::string > &  names)

Construct from a list of names.

Definition at line 78 of file substance.cc.

◆ initialize() [3/3]

void SubstanceList::initialize ( SubstanceList list)

Bind to existing list.

Definition at line 71 of file substance.cc.

◆ names()

const std::vector<std::string>& SubstanceList::names ( )
inline

Definition at line 85 of file substance.hh.

Here is the caller graph for this function:

◆ operator[]()

const Substance& SubstanceList::operator[] ( unsigned int  index)
inline

Definition at line 83 of file substance.hh.

◆ size()

unsigned int SubstanceList::size ( ) const
inline

Definition at line 87 of file substance.hh.

Here is the caller graph for this function:

Member Data Documentation

◆ names_

std::shared_ptr<std::vector<std::string> > SubstanceList::names_
private

Auxiliary list of substance names used in some classes.

Definition at line 95 of file substance.hh.

◆ substances_

std::shared_ptr<std::vector<Substance> > SubstanceList::substances_
private

The actual list of substances.

Definition at line 92 of file substance.hh.


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