Lazy enumeration of planes.
More...
#include <cvb/plane_enumerator.hpp>
Public Member Functions | |
PlaneEnumerator () noexcept | |
Plane enumerator constructor. More... | |
PlaneEnumerator (HandleGuard< PlaneEnumerator > &&guard, PrivateTag) noexcept | |
Plane enumerator constructor. More... | |
void * | Handle () const noexcept |
Classic API device handle. More... | |
int | PlaneCount () const noexcept |
Gets the number of planes enumerated by this object. More... | |
std::vector< PlanePtr > | Planes () const |
Gets all available planes enumerated by this object. More... | |
PlanePtr | operator[] (int index) const |
Index based plane access. More... | |
PlanePtr | Plane (int index) const |
Index based plane access. More... | |
Static Public Member Functions | |
template<class T > | |
static PlaneEnumerator | FromObject (const T &object) |
Create a plane enumerator for a given object. More... | |
static PlaneEnumeratorPtr | FromHandle (HandleGuard< PlaneEnumerator > &&guard) |
Creates a plane enumerator from a classic API handle. More... | |
Lazy enumeration of planes.
Enumerates planes (lazy) that belong to a arbitrary object respectively it's handle on demand.
|
inlinenoexcept |
Plane enumerator constructor.
This is not an invalid object, there are just no planes to enumerate.
|
inlinenoexcept |
Plane enumerator constructor.
Does | not throw any exception. |
|
inlinestatic |
Creates a plane enumerator from a classic API handle.
[in] | guard | Life time guard for C-API handle. |
|
static |
Create a plane enumerator for a given object.
[in] | object | That has a handle. |
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Classic API device handle.
Does | not throw any exception. |
It is normally not necessary to work with this handle.
|
inline |
Index based plane access.
[in] | index | Index of the plane. |
Any | exception derived from std::exception including CvbException. |
If the plane does not exist the access will throw.
Index based plane access.
[in] | index | Index of the plane. |
Any | exception derived from std::exception including CvbException. |
If the plane does not exist the access will throw.
|
inlinenoexcept |
Gets the number of planes enumerated by this object.
Does | not throw any exception. |
|
inline |
Gets all available planes enumerated by this object.
Any | exception derived from std::exception including CvbException. |