LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Public Member Functions | Public Attributes | List of all members
ast::FoundValue< T > Class Template Reference

A value and associated validity flag. More...

#include <FitsChan.h>

Public Member Functions

 FoundValue (bool found, T const &value)
 Construct a FoundValue. More...
 
 FoundValue ()
 Default constructor: found false, value is default-constructed. More...
 

Public Attributes

bool found
 Was the value found? More...
 
value
 The found value; ignore if found is false. More...
 

Detailed Description

template<typename T>
class ast::FoundValue< T >

A value and associated validity flag.

One could use std::pair instead, but this is a bit nicer, and also easier to python-wrap for complicated types.

Definition at line 68 of file FitsChan.h.

Constructor & Destructor Documentation

◆ FoundValue() [1/2]

template<typename T>
ast::FoundValue< T >::FoundValue ( bool  found,
T const &  value 
)
inline

Construct a FoundValue.

Parameters
[in]foundWas the value found?
[in]valueThe value (must be a valid value, even if found false)

Definition at line 76 of file FitsChan.h.

76 : found(found), value(value) {}
bool found
Was the value found?
Definition: FitsChan.h:80
T value
The found value; ignore if found is false.
Definition: FitsChan.h:81

◆ FoundValue() [2/2]

template<typename T>
ast::FoundValue< T >::FoundValue ( )
inline

Default constructor: found false, value is default-constructed.

Definition at line 79 of file FitsChan.h.

79 : found(false), value() {}
bool found
Was the value found?
Definition: FitsChan.h:80
T value
The found value; ignore if found is false.
Definition: FitsChan.h:81

Member Data Documentation

◆ found

template<typename T>
bool ast::FoundValue< T >::found

Was the value found?

Definition at line 80 of file FitsChan.h.

◆ value

template<typename T>
T ast::FoundValue< T >::value

The found value; ignore if found is false.

Definition at line 81 of file FitsChan.h.


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