Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | Public Attributes | List of all members
genvtx::weight_entry_type Struct Reference

Weight data for combined vertex generators. More...

#include <bayeux/genvtx/utils.h>

Public Member Functions

 weight_entry_type ()
 Default constructor. More...
 
bool is_valid () const
 Check the validity of weight parameters. More...
 
void reset ()
 Reset the weight parameters. More...
 
void invalidate ()
 Invalidate the weight parameters. More...
 
double get_weight () const
 Return the weight. More...
 
double get_cumulated_weight () const
 Return the cumulated weight. More...
 
const geomtools::geom_infoget_ginfo () const
 Return a reference to the non mutable geometry info. More...
 
bool has_ginfo () const
 Check if geometry info is available. More...
 

Public Attributes

double weight
 Weight. More...
 
double cumulated_weight
 Cumulated weight. More...
 
const geomtools::geom_infoginfo
 Handle to associated geometry data. More...
 

Detailed Description

Weight data for combined vertex generators.

Constructor & Destructor Documentation

◆ weight_entry_type()

genvtx::weight_entry_type::weight_entry_type ( )

Default constructor.

Member Function Documentation

◆ get_cumulated_weight()

double genvtx::weight_entry_type::get_cumulated_weight ( ) const

Return the cumulated weight.

◆ get_ginfo()

const geomtools::geom_info& genvtx::weight_entry_type::get_ginfo ( ) const

Return a reference to the non mutable geometry info.

◆ get_weight()

double genvtx::weight_entry_type::get_weight ( ) const

Return the weight.

◆ has_ginfo()

bool genvtx::weight_entry_type::has_ginfo ( ) const

Check if geometry info is available.

◆ invalidate()

void genvtx::weight_entry_type::invalidate ( )

Invalidate the weight parameters.

◆ is_valid()

bool genvtx::weight_entry_type::is_valid ( ) const

Check the validity of weight parameters.

◆ reset()

void genvtx::weight_entry_type::reset ( )

Reset the weight parameters.

Member Data Documentation

◆ cumulated_weight

double genvtx::weight_entry_type::cumulated_weight

Cumulated weight.

◆ ginfo

const geomtools::geom_info* genvtx::weight_entry_type::ginfo

Handle to associated geometry data.

◆ weight

double genvtx::weight_entry_type::weight

Weight.


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