Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
|
Provides an iterator over a DmTime in slices of DMs. More...
#include <cheetah/data/detail/DmTimeIterator.h>
Public Types | |
typedef DmTimeType::SliceType | SliceType |
Public Member Functions | |
DmTimeIterator (std::size_t current_dm_idx, std::size_t number_dms_per_slice, std::shared_ptr< DmTimeType > parent) | |
Create a new instances. More... | |
DmTimeIterator & | operator++ () |
Increment the iterator. More... | |
std::shared_ptr< SliceType > | operator* () const |
Dereference the iterator. More... | |
bool | operator!= (DmTimeIterator const &other) const |
Test if another DmTimeIterator is different to this one. More... | |
bool | operator== (DmTimeIterator const &other) const |
Test if another DmTimeIterator is the same as this one. More... | |
bool | operator< (DmTimeIterator const &other) const |
Test if another DmTimeIterator is the before this one. More... | |
bool | operator> (DmTimeIterator const &other) const |
Test if another DmTimeIterator is the after this one. More... | |
Provides an iterator over a DmTime in slices of DMs.
The DmTimeIterator is used to slice a DmTime into multiple SliceType instances, each of which provides access to a subset of DM trials stored in the DmTime.
Definition at line 28 of file DmTimeIterator.h.
ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::DmTimeIterator | ( | std::size_t | current_dm_idx, |
std::size_t | number_dms_per_slice, | ||
std::shared_ptr< DmTimeType > | parent | ||
) |
Create a new instances.
[in] | current_dm_idx | The current dm index |
[in] | number_dms_per_slice | The number dms per slice |
[in] | parent | The parent DmTime object |
Definition at line 9 of file DmTimeIterator.cpp.
bool ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator!= | ( | DmTimeIterator< DmTimeType > const & | other | ) | const |
Test if another DmTimeIterator is different to this one.
other | Another DmTimeIterator instance |
Definition at line 36 of file DmTimeIterator.cpp.
std::shared_ptr< typename DmTimeIterator< DmTimeType >::SliceType > ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator* | ( | ) | const |
Dereference the iterator.
Definition at line 30 of file DmTimeIterator.cpp.
DmTimeIterator< DmTimeType > & ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator++ | ( | ) |
Increment the iterator.
Definition at line 23 of file DmTimeIterator.cpp.
bool ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator< | ( | DmTimeIterator< DmTimeType > const & | other | ) | const |
Test if another DmTimeIterator is the before this one.
other | The other |
Definition at line 48 of file DmTimeIterator.cpp.
bool ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator== | ( | DmTimeIterator< DmTimeType > const & | other | ) | const |
Test if another DmTimeIterator is the same as this one.
other | Another DmTimeIterator instance |
Definition at line 42 of file DmTimeIterator.cpp.
bool ska::cheetah::data::detail::DmTimeIterator< DmTimeType >::operator> | ( | DmTimeIterator< DmTimeType > const & | other | ) | const |
Test if another DmTimeIterator is the after this one.
other | The other |
Definition at line 54 of file DmTimeIterator.cpp.