CountVolumeQuantity Class Reference

Collaboration diagram for CountVolumeQuantity:

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

Public Member Functions
	CountVolumeQuantity (CountVolumeQuantityType type)
	Constructor for the CountVolumeQuantity class.
CountVolumeQuantity	operator+ (const CountVolumeQuantity &other) const
	Overloads the + operator for CountVolumeQuantity.
void	measure (TempVolumeTallyData &temp_volume_tally_data)
	Measures the CountVolumeQuantity for a TempVolumeTallyData object.
CountVolumeQuantityType	getType () const
	Returns the type of the CountVolumeQuantity.
CountValue	getTotalValues ()
CountValue	getPrimaryValues () const
CountValue	getSingleIncoherentScatterValues () const
CountValue	getSingleCoherentScatterValues () const
CountValue	getMultipleScatterValues () const

Private Attributes
CountVolumeQuantityType	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

Definition at line 93 of file volume_quantity.h.

Member Typedef Documentation

ValueExtractor

using CountVolumeQuantity::ValueExtractor = std::function<bool(const TempVolumeTallyData&)>

ValueExtractor is a function that extracts necessary values from a TempVolumeTallyData object for a CountVolumeQuantity.

Parameters

temp_volume_tally_data

The TempVolumeTallyData object to extract the value from.

Returns

The value extracted from the TempVolumeTallyData object.

Definition at line 102 of file volume_quantity.h.

Constructor & Destructor Documentation

CountVolumeQuantity()

CountVolumeQuantity::CountVolumeQuantity ( CountVolumeQuantityType type )

explicit

Constructor for the CountVolumeQuantity class.

Parameters

type	The type of the CountVolumeQuantity to be measured.

Member Function Documentation

getType()

CountVolumeQuantityType CountVolumeQuantity::getType

(

)

const

Returns the type of the CountVolumeQuantity.

Returns

The type of the CountVolumeQuantity.

measure()

void CountVolumeQuantity::measure

(

TempVolumeTallyData &

temp_volume_tally_data

)

Measures the CountVolumeQuantity for a TempVolumeTallyData object.

Parameters

temp_volume_tally_data

The TempVolumeTallyData object to measure the CountVolumeQuantity for.

operator+()

CountVolumeQuantity CountVolumeQuantity::operator+

(

const CountVolumeQuantity &

other

)

const

Overloads the + operator for CountVolumeQuantity.

Parameters

other

The CountVolumeQuantity to add to this CountVolumeQuantity.

Returns

The sum of the two CountVolumeQuantity objects.

Member Data Documentation

multiple_scatter_values_

CountValue CountVolumeQuantity::multiple_scatter_values_

private

Definition at line 144 of file volume_quantity.h.

primary_values_

CountValue CountVolumeQuantity::primary_values_

private

Definition at line 141 of file volume_quantity.h.

single_coherent_scatter_values_

CountValue CountVolumeQuantity::single_coherent_scatter_values_

private

Definition at line 143 of file volume_quantity.h.

single_incoherent_scatter_values_

CountValue CountVolumeQuantity::single_incoherent_scatter_values_

private

Definition at line 142 of file volume_quantity.h.

total_values_

CountValue CountVolumeQuantity::total_values_

private

Definition at line 140 of file volume_quantity.h.

totaled_

bool CountVolumeQuantity::totaled_ = false

private

Definition at line 139 of file volume_quantity.h.

type_

CountVolumeQuantityType CountVolumeQuantity::type_

private

Definition at line 138 of file volume_quantity.h.

valueExtractor_

ValueExtractor CountVolumeQuantity::valueExtractor_

private

Definition at line 145 of file volume_quantity.h.

---

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

• include/MIDSX/Core/volume_quantity.h