#include <Analysis.h>

Public Member Functions
	Analysis ()
	Analysis (const Analysis &)=delete
Analysis &	operator= (const Analysis &)=delete
	Analysis (Analysis &&)=delete
Analysis &	operator= (Analysis &&)=delete
void	rename (EntityName value)
	Renames the analysis with normalized entity text.
void	rename (std::string value)
	Renames the analysis with raw text.
void	setType (AnalysisType value)
	Sets the analysis type from a value object.
void	setType (std::string value)
	Sets the analysis type from raw text.
void	setConfigJson (std::string value)
	Stores the raw configuration JSON.
void	setFilterSpec (FilterSpec value)
	Sets the filter specification from a value object.
void	setFilterSpec (std::string value)
	Sets the filter specification from raw text.
void	setExportFormat (ExportFormat value)
	Sets the export format from a value object.
void	setExportFormat (std::string value)
	Sets the export format from raw text.
void	setIncludeCalculationAdjustments (bool value)
	Enables or disables calculation adjustments.
void	setExportStateJson (std::string value)
	Stores the export state JSON snapshot.
void	setSnapshotTransactionsJson (std::string value)
	Stores the snapshot transactions JSON.
void	clearAdjustments ()
	Clears all adjustment entries.
void	setAdjustment (std::string key, double value)
	Sets or updates a normalized adjustment entry.
void	removeAdjustment (const std::string &key)
	Removes a normalized adjustment entry.
bool	hasAdjustment (const std::string &key) const
	Checks whether an adjustment exists.
std::size_t	adjustmentCount () const noexcept
	Returns the number of adjustments.
bool	hasType () const noexcept
	Checks whether the analysis has a valid type.
bool	hasExportFormat () const noexcept
	Checks whether the analysis has a valid export format.
bool	hasConfig () const noexcept
	Checks whether configuration JSON exists.
bool	hasFilterSpec () const noexcept
	Checks whether a filter specification exists.
bool	hasSnapshotTransactions () const noexcept
	Checks whether snapshot transactions are present.
bool	isReadyForExport () const noexcept
	Checks whether the analysis is ready to export.
bool	isConfigured () const noexcept
	Checks whether the analysis is configured sufficiently for processing.
bool	isTabular () const noexcept
	Checks whether the analysis type is tabular.
bool	isChartLike () const noexcept
	Checks whether the analysis type is chart-like.
bool	supportsExportFormat (const std::string &candidate) const
	Checks whether a candidate export format matches this analysis.
bool	hasAdjustments () const noexcept
	Checks whether at least one adjustment exists.
bool	isResultReady () const noexcept
	Checks whether the analysis has enough data to represent a result.
std::string	executionType () const
	Resolves the effective execution type for the analysis.
std::string	outputType () const
	Resolves the effective output type for the analysis.
const std::string &	id () const noexcept
const std::string &	name () const noexcept
const std::string &	type () const noexcept
const std::string &	configJson () const noexcept
const std::string &	filterSpec () const noexcept
const std::string &	exportFormat () const noexcept
const bool &	includeCalculationAdjustments () const noexcept
const std::string &	exportStateJson () const noexcept
const std::string &	snapshotTransactionsJson () const noexcept
const std::unordered_map< std::string, double > &	adjustments () const noexcept
const std::string &	createdAt () const noexcept
const std::string &	updatedAt () const noexcept
void	setId (std::string value)
void	setCreatedAt (std::string value)
void	setUpdatedAt (std::string value)

Detailed Description

Definition at line 23 of file Analysis.h.

Constructor & Destructor Documentation

◆ Analysis() [1/3]

core::domain::Analysis::Analysis ( )

default

Here is the caller graph for this function:

◆ Analysis() [2/3]

core::domain::Analysis::Analysis ( const Analysis & )

delete

Here is the call graph for this function:

◆ Analysis() [3/3]

core::domain::Analysis::Analysis ( Analysis && )

delete

Here is the call graph for this function:

Member Function Documentation

◆ adjustmentCount()

std::size_t core::domain::Analysis::adjustmentCount ( ) const

nodiscardnoexcept

Returns the number of adjustments.

Returns: Adjustment count.

Definition at line 129 of file Analysis.cpp.

◆ adjustments()

const std::unordered_map< std::string, double > & core::domain::Analysis::adjustments ( ) const

nodiscardnoexcept

Definition at line 202 of file Analysis.cpp.

Here is the caller graph for this function:

◆ clearAdjustments()

void core::domain::Analysis::clearAdjustments ( )

Clears all adjustment entries.

Definition at line 107 of file Analysis.cpp.

◆ configJson()

const std::string & core::domain::Analysis::configJson ( ) const

nodiscardnoexcept

Definition at line 196 of file Analysis.cpp.

Here is the caller graph for this function:

◆ createdAt()

const std::string & core::domain::Analysis::createdAt ( ) const

nodiscardnoexcept

Definition at line 203 of file Analysis.cpp.

Here is the caller graph for this function:

◆ executionType()

std::string core::domain::Analysis::executionType ( ) const

nodiscard

Resolves the effective execution type for the analysis.

Returns: Effective execution type key.

Definition at line 185 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportFormat()

const std::string & core::domain::Analysis::exportFormat ( ) const

nodiscardnoexcept

Definition at line 198 of file Analysis.cpp.

Here is the caller graph for this function:

◆ exportStateJson()

const std::string & core::domain::Analysis::exportStateJson ( ) const

nodiscardnoexcept

Definition at line 200 of file Analysis.cpp.

Here is the caller graph for this function:

◆ filterSpec()

const std::string & core::domain::Analysis::filterSpec ( ) const

nodiscardnoexcept

Definition at line 197 of file Analysis.cpp.

Here is the caller graph for this function:

◆ hasAdjustment()

bool core::domain::Analysis::hasAdjustment ( const std::string & key ) const

nodiscard

Checks whether an adjustment exists.

Parameters

key	Raw adjustment key.

Returns: true when the adjustment exists.

Definition at line 124 of file Analysis.cpp.

Here is the call graph for this function:

◆ hasAdjustments()

bool core::domain::Analysis::hasAdjustments ( ) const

nodiscardnoexcept

Checks whether at least one adjustment exists.

Returns: true when the adjustment map is not empty.

Definition at line 177 of file Analysis.cpp.

Here is the caller graph for this function:

◆ hasConfig()

bool core::domain::Analysis::hasConfig ( ) const

nodiscardnoexcept

Checks whether configuration JSON exists.

Returns: true when configuration JSON is non-empty.

Definition at line 141 of file Analysis.cpp.

Here is the caller graph for this function:

◆ hasExportFormat()

bool core::domain::Analysis::hasExportFormat ( ) const

nodiscardnoexcept

Checks whether the analysis has a valid export format.

Returns: true when the export format is not empty.

Definition at line 137 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasFilterSpec()

bool core::domain::Analysis::hasFilterSpec ( ) const

nodiscardnoexcept

Checks whether a filter specification exists.

Returns: true when the filter spec is not empty.

Definition at line 145 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSnapshotTransactions()

bool core::domain::Analysis::hasSnapshotTransactions ( ) const

nodiscardnoexcept

Checks whether snapshot transactions are present.

Returns: true when snapshot transactions JSON is non-empty.

Definition at line 149 of file Analysis.cpp.

Here is the caller graph for this function:

◆ hasType()

bool core::domain::Analysis::hasType ( ) const

nodiscardnoexcept

Checks whether the analysis has a valid type.

Returns: true when the type passes policy validation.

Definition at line 133 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ id()

const std::string & core::domain::Analysis::id ( ) const

nodiscardnoexcept

Definition at line 193 of file Analysis.cpp.

◆ includeCalculationAdjustments()

const bool & core::domain::Analysis::includeCalculationAdjustments ( ) const

nodiscardnoexcept

Definition at line 199 of file Analysis.cpp.

Here is the caller graph for this function:

◆ isChartLike()

bool core::domain::Analysis::isChartLike ( ) const

nodiscardnoexcept

Checks whether the analysis type is chart-like.

Returns: true when the analysis produces chart-like output.

Definition at line 165 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isConfigured()

bool core::domain::Analysis::isConfigured ( ) const

nodiscardnoexcept

Checks whether the analysis is configured sufficiently for processing.

Returns: true when policy validation accepts the current state.

Definition at line 157 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReadyForExport()

bool core::domain::Analysis::isReadyForExport ( ) const

nodiscardnoexcept

Checks whether the analysis is ready to export.

Returns: true when type and export format are valid.

Definition at line 153 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isResultReady()

bool core::domain::Analysis::isResultReady ( ) const

nodiscardnoexcept

Checks whether the analysis has enough data to represent a result.

Returns: true when any major result field is present.

Definition at line 181 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTabular()

bool core::domain::Analysis::isTabular ( ) const

nodiscardnoexcept

Checks whether the analysis type is tabular.

Returns: true when the analysis produces tabular output.

Definition at line 161 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const std::string & core::domain::Analysis::name ( ) const

nodiscardnoexcept

Definition at line 194 of file Analysis.cpp.

Here is the caller graph for this function:

◆ operator=() [1/2]

Analysis & core::domain::Analysis::operator= ( Analysis && )

delete

Here is the call graph for this function:

◆ operator=() [2/2]

Analysis & core::domain::Analysis::operator= ( const Analysis & )

delete

Here is the call graph for this function:

◆ outputType()

std::string core::domain::Analysis::outputType ( ) const

nodiscard

Resolves the effective output type for the analysis.

Returns: Resolved output type key.

Definition at line 189 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAdjustment()

void core::domain::Analysis::removeAdjustment ( const std::string & key )

Removes a normalized adjustment entry.

Parameters

key	Raw adjustment key.

Definition at line 119 of file Analysis.cpp.

Here is the call graph for this function:

◆ rename() [1/2]

void core::domain::Analysis::rename ( EntityName value )

Renames the analysis with normalized entity text.

Parameters

value Normalized entity name wrapper.

Definition at line 16 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rename() [2/2]

void core::domain::Analysis::rename ( std::string value )

Renames the analysis with raw text.

Parameters

value Raw entity name text.

Definition at line 20 of file Analysis.cpp.

Here is the call graph for this function:

◆ setAdjustment()

void core::domain::Analysis::setAdjustment	(	std::string	key,
		double	value )

Sets or updates a normalized adjustment entry.

Parameters

key	Raw adjustment key.
value	Adjustment amount.

Definition at line 111 of file Analysis.cpp.

Here is the call graph for this function:

◆ setConfigJson()

void core::domain::Analysis::setConfigJson ( std::string value )

Stores the raw configuration JSON.

Parameters

value Configuration JSON text.

Definition at line 32 of file Analysis.cpp.

◆ setCreatedAt()

void core::domain::Analysis::setCreatedAt ( std::string value )

Definition at line 206 of file Analysis.cpp.

Here is the caller graph for this function:

◆ setExportFormat() [1/2]

void core::domain::Analysis::setExportFormat ( ExportFormat value )

Sets the export format from a value object.

Parameters

value Normalized export format wrapper.

Definition at line 44 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setExportFormat() [2/2]

void core::domain::Analysis::setExportFormat ( std::string value )

Sets the export format from raw text.

Parameters

value Raw export format text.

Definition at line 48 of file Analysis.cpp.

Here is the call graph for this function:

◆ setExportStateJson()

void core::domain::Analysis::setExportStateJson ( std::string value )

Stores the export state JSON snapshot.

Parameters

value Export state JSON text.

Definition at line 56 of file Analysis.cpp.

◆ setFilterSpec() [1/2]

void core::domain::Analysis::setFilterSpec ( FilterSpec value )

Sets the filter specification from a value object.

Parameters

value Normalized filter specification wrapper.

Definition at line 36 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFilterSpec() [2/2]

void core::domain::Analysis::setFilterSpec ( std::string value )

Sets the filter specification from raw text.

Parameters

value Raw filter specification text.

Definition at line 40 of file Analysis.cpp.

Here is the call graph for this function:

◆ setId()

void core::domain::Analysis::setId ( std::string value )

Definition at line 205 of file Analysis.cpp.

Here is the caller graph for this function:

◆ setIncludeCalculationAdjustments()

void core::domain::Analysis::setIncludeCalculationAdjustments ( bool value )

Enables or disables calculation adjustments.

Parameters

value Adjustment flag.

Definition at line 52 of file Analysis.cpp.

◆ setSnapshotTransactionsJson()

void core::domain::Analysis::setSnapshotTransactionsJson ( std::string value )

Stores the snapshot transactions JSON.

Parameters

value Snapshot transactions JSON text.

Definition at line 60 of file Analysis.cpp.

◆ setType() [1/2]

void core::domain::Analysis::setType ( AnalysisType value )

Sets the analysis type from a value object.

Parameters

value Normalized analysis type wrapper.

Definition at line 24 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType() [2/2]

void core::domain::Analysis::setType ( std::string value )

Sets the analysis type from raw text.

Parameters

value Raw analysis type text.

Definition at line 28 of file Analysis.cpp.

Here is the call graph for this function:

◆ setUpdatedAt()

void core::domain::Analysis::setUpdatedAt ( std::string value )

Definition at line 207 of file Analysis.cpp.

Here is the caller graph for this function:

◆ snapshotTransactionsJson()

const std::string & core::domain::Analysis::snapshotTransactionsJson ( ) const

nodiscardnoexcept

Definition at line 201 of file Analysis.cpp.

Here is the caller graph for this function:

◆ supportsExportFormat()

bool core::domain::Analysis::supportsExportFormat ( const std::string & candidate ) const

nodiscard

Checks whether a candidate export format matches this analysis.

Parameters

candidate Export format to check.

Returns: true when the candidate matches the stored export format.

Definition at line 169 of file Analysis.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ type()

const std::string & core::domain::Analysis::type ( ) const

nodiscardnoexcept

Definition at line 195 of file Analysis.cpp.

Here is the caller graph for this function:

◆ updatedAt()

const std::string & core::domain::Analysis::updatedAt ( ) const

nodiscardnoexcept

Definition at line 204 of file Analysis.cpp.

Here is the caller graph for this function:

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Analysis() [1/3]

◆ Analysis() [2/3]

◆ Analysis() [3/3]

Member Function Documentation

◆ adjustmentCount()

◆ adjustments()

◆ clearAdjustments()

◆ configJson()

◆ createdAt()

◆ executionType()

◆ exportFormat()

◆ exportStateJson()

◆ filterSpec()

◆ hasAdjustment()

◆ hasAdjustments()

◆ hasConfig()

◆ hasExportFormat()

◆ hasFilterSpec()

◆ hasSnapshotTransactions()

◆ hasType()

◆ id()

◆ includeCalculationAdjustments()

◆ isChartLike()

◆ isConfigured()

◆ isReadyForExport()

◆ isResultReady()

◆ isTabular()

◆ name()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ outputType()

◆ removeAdjustment()

◆ rename() [1/2]

◆ rename() [2/2]

◆ setAdjustment()

◆ setConfigJson()

◆ setCreatedAt()

◆ setExportFormat() [1/2]

◆ setExportFormat() [2/2]

◆ setExportStateJson()

◆ setFilterSpec() [1/2]

◆ setFilterSpec() [2/2]

◆ setId()

◆ setIncludeCalculationAdjustments()

◆ setSnapshotTransactionsJson()

◆ setType() [1/2]

◆ setType() [2/2]

◆ setUpdatedAt()

◆ snapshotTransactionsJson()

◆ supportsExportFormat()

◆ type()

◆ updatedAt()