Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | List of all members
materials::compound_entry Class Reference

Material compound entry. More...

#include <bayeux/materials/material.h>

Public Member Functions

 compound_entry ()
 Constructor. More...
 
 ~compound_entry ()
 Destructor. More...
 
bool is_valid () const
 Check validity. More...
 
bool has_element () const
 Check for a element compound. More...
 
bool has_material () const
 Check for a material compound. More...
 
bool is_owned () const
 Check for an owned compound. More...
 
bool has_weight () const
 Check the weight. More...
 
bool has_number_of_atoms () const
 Check the number of atoms. More...
 
double get_weight () const
 Return the weight. More...
 
void set_weight (double)
 Set the weight. More...
 
int get_number_of_atoms () const
 Return the number of atoms. More...
 
void set_number_of_atoms (int)
 Set the number of atoms. More...
 
void set_element (const element &elt_, bool owned_=false)
 Set the element. More...
 
void set_material (const material &mat_, bool owned_=false)
 Set the material. More...
 
void set_element (const element *elt_, bool owned_=true)
 Set the element. More...
 
void set_material (const material *mat_, bool owned_=true)
 Set the material. More...
 
const elementget_element () const
 Return the compound element. More...
 
const materialget_material () const
 Return the compound material. More...
 
void reset ()
 Reset. More...
 
void reset_compound ()
 Reset the compound. More...
 

Detailed Description

Material compound entry.

Constructor & Destructor Documentation

◆ compound_entry()

materials::compound_entry::compound_entry ( )

Constructor.

◆ ~compound_entry()

materials::compound_entry::~compound_entry ( )

Destructor.

Member Function Documentation

◆ get_element()

const element& materials::compound_entry::get_element ( ) const

Return the compound element.

◆ get_material()

const material& materials::compound_entry::get_material ( ) const

Return the compound material.

◆ get_number_of_atoms()

int materials::compound_entry::get_number_of_atoms ( ) const

Return the number of atoms.

◆ get_weight()

double materials::compound_entry::get_weight ( ) const

Return the weight.

◆ has_element()

bool materials::compound_entry::has_element ( ) const

Check for a element compound.

◆ has_material()

bool materials::compound_entry::has_material ( ) const

Check for a material compound.

◆ has_number_of_atoms()

bool materials::compound_entry::has_number_of_atoms ( ) const

Check the number of atoms.

◆ has_weight()

bool materials::compound_entry::has_weight ( ) const

Check the weight.

◆ is_owned()

bool materials::compound_entry::is_owned ( ) const

Check for an owned compound.

◆ is_valid()

bool materials::compound_entry::is_valid ( ) const

Check validity.

◆ reset()

void materials::compound_entry::reset ( )

Reset.

◆ reset_compound()

void materials::compound_entry::reset_compound ( )

Reset the compound.

◆ set_element() [1/2]

void materials::compound_entry::set_element ( const element elt_,
bool  owned_ = false 
)

Set the element.

◆ set_element() [2/2]

void materials::compound_entry::set_element ( const element elt_,
bool  owned_ = true 
)

Set the element.

◆ set_material() [1/2]

void materials::compound_entry::set_material ( const material mat_,
bool  owned_ = false 
)

Set the material.

◆ set_material() [2/2]

void materials::compound_entry::set_material ( const material mat_,
bool  owned_ = true 
)

Set the material.

◆ set_number_of_atoms()

void materials::compound_entry::set_number_of_atoms ( int  )

Set the number of atoms.

◆ set_weight()

void materials::compound_entry::set_weight ( double  )

Set the weight.


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