CountSurfaceQuantity Class Reference

Class which represents a count quantity for a surface tally. More...

#include <surface_quantity.h>

Collaboration diagram for CountSurfaceQuantity:

Public Types
using	ValueExtractor = std::function<bool(const TempSurfaceTallyData&)>
	ValueExtractor is a function that extracts necessary values from a TempSurfaceTallyData object for a CountSurfaceQuantity.

Public Member Functions
	CountSurfaceQuantity (CountSurfaceQuantityType type)
	Constructor for the CountSurfaceQuantity class.
CountSurfaceQuantity	operator+ (const CountSurfaceQuantity &other) const
	Overloads the + operator for CountSurfaceQuantity.
void	measure (TempSurfaceTallyData &temp_surface_tally_data)
	Measures the CountSurfaceQuantity for a TempSurfaceTallyData object.
CountSurfaceQuantityType	getType () const
	Returns the type of the CountSurfaceQuantity.
CountValue	getTotalValues ()
CountValue	getPrimaryValues () const
CountValue	getSingleIncoherentScatterValues () const
CountValue	getSingleCoherentScatterValues () const
CountValue	getMultipleScatterValues () const

Private Attributes
CountSurfaceQuantityType	type_
bool	totaled_ = false
CountValue	total_values_
CountValue	primary_values_
CountValue	single_incoherent_scatter_values_
CountValue	single_coherent_scatter_values_
CountValue	multiple_scatter_values_
ValueExtractor	valueExtractor_

Detailed Description

Class which represents a count quantity for a surface tally.

Essentially a wrapper around the CountValue class but is specific to a measurement type

Definition at line 102 of file surface_quantity.h.

Member Typedef Documentation

ValueExtractor

using CountSurfaceQuantity::ValueExtractor = std::function<bool(const TempSurfaceTallyData&)>

ValueExtractor is a function that extracts necessary values from a TempSurfaceTallyData object for a CountSurfaceQuantity.

Parameters

temp_surface_tally_data

The TempSurfaceTallyData object to extract the value from.

Returns

The value extracted from the TempSurfaceTallyData object.

Definition at line 110 of file surface_quantity.h.

Constructor & Destructor Documentation

CountSurfaceQuantity()

CountSurfaceQuantity::CountSurfaceQuantity ( CountSurfaceQuantityType type )

explicit

Constructor for the CountSurfaceQuantity class.

Parameters

type	The type of the CountSurfaceQuantity to be measured.

Member Function Documentation

getType()

CountSurfaceQuantityType CountSurfaceQuantity::getType

(

)

const

Returns the type of the CountSurfaceQuantity.

Returns

The type of the CountSurfaceQuantity.

measure()

void CountSurfaceQuantity::measure

(

TempSurfaceTallyData &

temp_surface_tally_data

)

Measures the CountSurfaceQuantity for a TempSurfaceTallyData object.

Parameters

temp_surface_tally_data

The TempSurfaceTallyData object to measure the CountSurfaceQuantity for.

operator+()

CountSurfaceQuantity CountSurfaceQuantity::operator+

(

const CountSurfaceQuantity &

other

)

const

Overloads the + operator for CountSurfaceQuantity.

Parameters

other

The CountSurfaceQuantity to add to this CountSurfaceQuantity.

Returns

The sum of the two CountSurfaceQuantity objects.

Member Data Documentation

multiple_scatter_values_

CountValue CountSurfaceQuantity::multiple_scatter_values_

private

Definition at line 154 of file surface_quantity.h.

primary_values_

CountValue CountSurfaceQuantity::primary_values_

private

Definition at line 151 of file surface_quantity.h.

single_coherent_scatter_values_

CountValue CountSurfaceQuantity::single_coherent_scatter_values_

private

Definition at line 153 of file surface_quantity.h.

single_incoherent_scatter_values_

CountValue CountSurfaceQuantity::single_incoherent_scatter_values_

private

Definition at line 152 of file surface_quantity.h.

total_values_

CountValue CountSurfaceQuantity::total_values_

private

Definition at line 150 of file surface_quantity.h.

totaled_

bool CountSurfaceQuantity::totaled_ = false

private

Definition at line 149 of file surface_quantity.h.

type_

CountSurfaceQuantityType CountSurfaceQuantity::type_

private

Definition at line 148 of file surface_quantity.h.

valueExtractor_

ValueExtractor CountSurfaceQuantity::valueExtractor_

private

Definition at line 155 of file surface_quantity.h.

---

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

• include/MIDSX/Core/surface_quantity.h