Information about the weighting of combined vertex generators. More...

#include <bayeux/genvtx/utils.h>

Public Types
enum	weighting_type { WEIGHTING_NONE = 0, WEIGHTING_SURFACE = 1, WEIGHTING_VOLUME = 2, WEIGHTING_BULK = WEIGHTING_VOLUME, WEIGHTING_MASS = 3 }
	Weighting type for combined vertex generators. More...

Public Member Functions
void	invalidate ()
	Invalidate the weighting informations. More...

bool	has_type () const
	Check if a weighting type is present. More...

bool	has_surface () const
	Check for surface weigthing. More...

bool	has_volume () const
	Check for volume weigthing. More...

bool	has_mass () const
	Check for mass weigthing. More...

bool	is_valid () const
	Check the validity of weighting informations. More...

double	get_surface () const
	Return the associated surface. More...

double	get_volume () const
	Return the associated volume. More...

double	get_mass () const
	Return the associated mass. More...

void	set_mass (double)
	Set the associated mass. More...

void	set_value (double)
	Set the reference weighting value. More...

void	set_type (int)
	Set the weighting type. More...

int	get_type () const
	Return the weighting type. More...

double	get_value () const
	Return the reference weighting value. More...

	weight_info ()
	Default constructor. More...

void	dump (std::ostream &=std::clog, const std::string &title_="") const
	Print. More...

Detailed Description

Information about the weighting of combined vertex generators.

Member Enumeration Documentation

◆ weighting_type

enum genvtx::weight_info::weighting_type

Weighting type for combined vertex generators.

Enumerator
WEIGHTING_NONE	No weighting.
WEIGHTING_SURFACE	weighting by surface
WEIGHTING_VOLUME	weighting by volume
WEIGHTING_BULK	weighting by volume
WEIGHTING_MASS	weighting by mass

Constructor & Destructor Documentation

◆ weight_info()

genvtx::weight_info::weight_info ( )

Default constructor.

Member Function Documentation

◆ dump()

void genvtx::weight_info::dump	(	std::ostream &	= `std::clog`,
		const std::string &	title_ = `""`
	)		const

Print.

◆ get_mass()

double genvtx::weight_info::get_mass ( ) const

Return the associated mass.

◆ get_surface()

double genvtx::weight_info::get_surface ( ) const

Return the associated surface.

◆ get_type()

int genvtx::weight_info::get_type ( ) const

Return the weighting type.

◆ get_value()

double genvtx::weight_info::get_value ( ) const

Return the reference weighting value.

◆ get_volume()

double genvtx::weight_info::get_volume ( ) const

Return the associated volume.

◆ has_mass()

bool genvtx::weight_info::has_mass ( ) const

Check for mass weigthing.

◆ has_surface()

bool genvtx::weight_info::has_surface ( ) const

Check for surface weigthing.

◆ has_type()

bool genvtx::weight_info::has_type ( ) const

Check if a weighting type is present.

◆ has_volume()

bool genvtx::weight_info::has_volume ( ) const

Check for volume weigthing.

◆ invalidate()

void genvtx::weight_info::invalidate ( )

Invalidate the weighting informations.

◆ is_valid()

bool genvtx::weight_info::is_valid ( ) const

Check the validity of weighting informations.

◆ set_mass()

void genvtx::weight_info::set_mass ( double )

Set the associated mass.

◆ set_type()

void genvtx::weight_info::set_type ( int )

Set the weighting type.

◆ set_value()

void genvtx::weight_info::set_value ( double )

Set the reference weighting value.

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

bayeux/genvtx/utils.h

Public Types

Public Member Functions