Struct astrea::trace::AccessStats¶

ClassList > astrea > trace > AccessStats

The AccessStats struct represents statistics for access times based on anAccessArray .More...

#include <AccessStats.hpp>

Public Functions¶

Type	Name
	AccessStats () = default Default constructor for AccessStats .
	AccessStats (const AccessArray & accesses) Constructs an AccessStats object from anAccessArray .
const auto &	get_access_metric (std::size_t receiverId, const AccessMetric & metric) const Accesses the access statistics for a given receiver ID and AccessMetric.
const auto &	get_access_metrics () const Accesses the access statistics for all receiver IDs and AccessMetrics.
const auto &	get_access_statistics (const AccessMetric & metric) const Accesses the rise/set statistics for a given receiver ID.
const auto &	get_hyper_statistics (const RiseSetMetric & metric) const Accesses the statistics for a given RiseSetMetric.
auto &	get_hyper_statistics (const RiseSetMetric & metric) Accesses the statistics for a given RiseSetMetric.
const auto &	get_riseset_statistics () const Accesses the rise/set statistics for all receivers.
const auto &	get_riseset_statistics (std::size_t receiverId) const Accesses the rise/set statistics for a given receiver ID.
std::vector< std::string >	to_string_vector () const Converts the statistics to a vector of strings for output.

Detailed Description¶

It contains maps for aggregate rise sets and their statistics for each receiver ID, as well as individual rise set statistics for each sender-receiver pair and hyper statistics for each receiver ID.

Public Functions Documentation¶

function AccessStats [1/2]¶

Default constructor for AccessStats .

astrea::trace::AccessStats::AccessStats () = default

function AccessStats [2/2]¶

Constructs an AccessStats object from anAccessArray .

astrea::trace::AccessStats::AccessStats (
    const AccessArray & accesses
)

Parameters:

accesses The AccessArray containing the access times to calculate statistics for.

function get_access_metric¶

Accesses the access statistics for a given receiver ID and AccessMetric.

inline const auto & astrea::trace::AccessStats::get_access_metric (
    std::size_t receiverId,
    const AccessMetric & metric
) const

Parameters:

receiverId The ID of the receiver to access statistics for.
metric The AccessMetric to access statistics for.

Returns:

const Time& A reference to the Time object containing the statistic for the given receiver ID and metric.

function get_access_metrics¶

Accesses the access statistics for all receiver IDs and AccessMetrics.

inline const auto & astrea::trace::AccessStats::get_access_metrics () const

Returns:

const gtl::btree_map<std::size_t, gtl::btree_map<AccessMetric, Time>>& A reference to the map containing the access metrics for all receiver IDs and AccessMetrics.

function get_access_statistics¶

Accesses the rise/set statistics for a given receiver ID.

inline const auto & astrea::trace::AccessStats::get_access_statistics (
    const AccessMetric & metric
) const

Parameters:

receiverId The ID of the receiver to access statistics for.

Returns:

const RiseSetStats& A reference to the RiseSetStats object containing the statistics for the given receiver ID.

function get_hyper_statistics [1/2]¶

Accesses the statistics for a given RiseSetMetric.

inline const auto & astrea::trace::AccessStats::get_hyper_statistics (
    const RiseSetMetric & metric
) const

Parameters:

metric The RiseSetMetric to access statistics for.

Returns:

const Stats<Time>& A reference to the Stats<Time> object containing the statistics for the given metric.

function get_hyper_statistics [2/2]¶

Accesses the statistics for a given RiseSetMetric.

inline auto & astrea::trace::AccessStats::get_hyper_statistics (
    const RiseSetMetric & metric
)

Parameters:

metric The RiseSetMetric to access statistics for.

Returns:

Stats<Time>& A reference to the Stats<Time> object containing the statistics for the given metric.

function get_riseset_statistics [1/2]¶

Accesses the rise/set statistics for all receivers.

inline const auto & astrea::trace::AccessStats::get_riseset_statistics () const

Returns:

const RiseSetStats& A reference to the RiseSetStats object containing the statistics for the given receiver ID.

function get_riseset_statistics [2/2]¶

Accesses the rise/set statistics for a given receiver ID.

inline const auto & astrea::trace::AccessStats::get_riseset_statistics (
    std::size_t receiverId
) const

Parameters:

receiverId The ID of the receiver to access statistics for.

Returns:

const RiseSetStats& A reference to the RiseSetStats object containing the statistics for the given receiver ID.

function to_string_vector¶

Converts the statistics to a vector of strings for output.

std::vector< std::string > astrea::trace::AccessStats::to_string_vector () const

Returns:

std::vector<std::string> A vector of strings representing the statistics for each receiver ID and metric.

The documentation for this class was generated from the following file astrea/trace/trace/analysis/stats/AccessStats.hpp