VectorVolumeQuantity Class Reference

Class which represents a vector quantity for a volume tally. More...

#include <volume_quantity.h>

Collaboration diagram for VectorVolumeQuantity:

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

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

Private Attributes
VectorVolumeQuantityType	type_
bool	totaled_ = false
VectorValue	total_values_
VectorValue	primary_values_
VectorValue	single_incoherent_scatter_values_
VectorValue	single_coherent_scatter_values_
VectorValue	multiple_scatter_values_
ValueExtractor	valueExtractor_

Detailed Description

Class which represents a vector quantity for a volume tally.

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

Definition at line 39 of file volume_quantity.h.

Member Typedef Documentation

ValueExtractor

using VectorVolumeQuantity::ValueExtractor = std::function<double(const TempVolumeTallyData&)>

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

Parameters

temp_volume_tally_data

The TempVolumeTallyData object to extract the value from.

Returns

The value extracted from the TempVolumeTallyData object.

Definition at line 47 of file volume_quantity.h.

Constructor & Destructor Documentation

VectorVolumeQuantity()

VectorVolumeQuantity::VectorVolumeQuantity ( VectorVolumeQuantityType type )

explicit

Constructor for the VectorVolumeQuantity class.

Parameters

type	The type of the VectorVolumeQuantity to be measured.

Member Function Documentation

getType()

VectorVolumeQuantityType VectorVolumeQuantity::getType

(

)

const

Returns the type of the VectorVolumeQuantity.

Returns

The type of the VectorVolumeQuantity.

measure()

void VectorVolumeQuantity::measure

(

TempVolumeTallyData &

temp_volume_tally_data

)

Measures the VectorVolumeQuantity for a TempVolumeTallyData object.

Parameters

temp_volume_tally_data

The TempVolumeTallyData object to measure the VectorVolumeQuantity for.

operator+()

VectorVolumeQuantity VectorVolumeQuantity::operator+

(

VectorVolumeQuantity &

other

)

const

Overloads the + operator for VectorVolumeQuantity.

Parameters

other

The VectorVolumeQuantity to add to this VectorVolumeQuantity.

Returns

The sum of the two VectorVolumeQuantity objects.

Member Data Documentation

multiple_scatter_values_

VectorValue VectorVolumeQuantity::multiple_scatter_values_

private

Definition at line 89 of file volume_quantity.h.

primary_values_

VectorValue VectorVolumeQuantity::primary_values_

private

Definition at line 86 of file volume_quantity.h.

single_coherent_scatter_values_

VectorValue VectorVolumeQuantity::single_coherent_scatter_values_

private

Definition at line 88 of file volume_quantity.h.

single_incoherent_scatter_values_

VectorValue VectorVolumeQuantity::single_incoherent_scatter_values_

private

Definition at line 87 of file volume_quantity.h.

total_values_

VectorValue VectorVolumeQuantity::total_values_

private

Definition at line 85 of file volume_quantity.h.

totaled_

bool VectorVolumeQuantity::totaled_ = false

private

Definition at line 84 of file volume_quantity.h.

type_

VectorVolumeQuantityType VectorVolumeQuantity::type_

private

Definition at line 83 of file volume_quantity.h.

valueExtractor_

ValueExtractor VectorVolumeQuantity::valueExtractor_

private

Definition at line 90 of file volume_quantity.h.

---

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

• include/MIDSX/Core/volume_quantity.h