Bayeux  3.4.1
Core Foundation library for SuperNEMO
Public Member Functions | List of all members
datatools::configuration::array_occurrence Class Reference

Single occurrence. More...

#include <bayeux/datatools/configuration/array_occurrence.h>

Inheritance diagram for datatools::configuration::array_occurrence:

Public Member Functions

void set_size (unsigned int sz_)
 Set the size of the array. More...
unsigned int get_size () const
 Return the size of the array. More...
void set_start_id (int sid_)
 Set the starting id. More...
int get_start_id () const
 Get the starting id. More...
 array_occurrence ()
 Constructor. More...
virtual ~array_occurrence ()
 Destructor. More...
virtual size_t get_dimension () const
 Return the dimension. More...
virtual size_t get_number_of_occurrences () const
 Return the number of occurrences. More...
virtual void compute_occurrence (int rank_, single_occurrence &occ_) const
 Compute the occurrence associated to a given rank. More...
virtual size_t compute_index_path (std::vector< uint32_t > &path_, int rank_) const
 Compute a multidimensional index path from a rank. More...
virtual std::string to_string () const
 Convert to a string. More...
- Public Member Functions inherited from datatools::configuration::i_occurrence
 i_occurrence ()
 Constructor. More...
virtual ~i_occurrence ()
 Destructor. More...
bool is_multiple () const
 Check if occurrence is multiple. More...
single_occurrence get_occurrence_by_rank (int rank_) const
 Compute the occurrence associated to a given rank. More...

Additional Inherited Members

- Static Public Attributes inherited from datatools::configuration::i_occurrence
static const int INVALID_ID = -2
static const int SINGLE_ID = -1

Detailed Description

Single occurrence.

Constructor & Destructor Documentation

◆ array_occurrence()

datatools::configuration::array_occurrence::array_occurrence ( )


◆ ~array_occurrence()

virtual datatools::configuration::array_occurrence::~array_occurrence ( )


Member Function Documentation

◆ compute_index_path()

virtual size_t datatools::configuration::array_occurrence::compute_index_path ( std::vector< uint32_t > &  path_,
int  rank_ 
) const

Compute a multidimensional index path from a rank.

Implements datatools::configuration::i_occurrence.

◆ compute_occurrence()

virtual void datatools::configuration::array_occurrence::compute_occurrence ( int  rank_,
single_occurrence occ_ 
) const

Compute the occurrence associated to a given rank.

Implements datatools::configuration::i_occurrence.

◆ get_dimension()

virtual size_t datatools::configuration::array_occurrence::get_dimension ( ) const

Return the dimension.

Implements datatools::configuration::i_occurrence.

◆ get_number_of_occurrences()

virtual size_t datatools::configuration::array_occurrence::get_number_of_occurrences ( ) const

Return the number of occurrences.

Implements datatools::configuration::i_occurrence.

◆ get_size()

unsigned int datatools::configuration::array_occurrence::get_size ( ) const

Return the size of the array.

◆ get_start_id()

int datatools::configuration::array_occurrence::get_start_id ( ) const

Get the starting id.

◆ set_size()

void datatools::configuration::array_occurrence::set_size ( unsigned int  sz_)

Set the size of the array.

◆ set_start_id()

void datatools::configuration::array_occurrence::set_start_id ( int  sid_)

Set the starting id.

◆ to_string()

virtual std::string datatools::configuration::array_occurrence::to_string ( ) const

Convert to a string.

Implements datatools::configuration::i_occurrence.

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