lsst::afw::fits::HduMoveGuard Class Reference

RAII scoped guard for moving the HDU in a Fits object. More...

#include <fits.h>

Public Member Functions
	HduMoveGuard ()=delete
	HduMoveGuard (HduMoveGuard const &)=delete
	HduMoveGuard (HduMoveGuard &&)=delete
HduMoveGuard &	operator= (HduMoveGuard const &)=delete
HduMoveGuard &	operator= (HduMoveGuard &&)=delete
	HduMoveGuard (Fits &fits, int hdu, bool relative=false)
	Create a guard object and set the HDU of the given Fits object at the same time.
	~HduMoveGuard ()
void	disable ()
	Disable the guard, leaving the HDU at its current state at destruction.

Detailed Description

RAII scoped guard for moving the HDU in a Fits object.

This class attempts to ensure that the HDU state of a Fits object is restored when the guard class goes out of scope, even in the presence of exceptions. (In practice, resetting the HDU can only fail if the Fits object has become sufficiently corrupted that it's no longer usable at all).

Definition at line 706 of file fits.h.

Constructor & Destructor Documentation

HduMoveGuard() [1/4]

lsst::afw::fits::HduMoveGuard::HduMoveGuard ( )

delete

HduMoveGuard() [2/4]

lsst::afw::fits::HduMoveGuard::HduMoveGuard ( HduMoveGuard const & )

delete

HduMoveGuard() [3/4]

lsst::afw::fits::HduMoveGuard::HduMoveGuard ( HduMoveGuard && )

delete

HduMoveGuard() [4/4]

lsst::afw::fits::HduMoveGuard::HduMoveGuard	(	Fits &	fits,
		int	hdu,
		bool	relative = false )

Create a guard object and set the HDU of the given Fits object at the same time.

Parameters

[in,out]	fits	FITS file pointer to manipulate.
[in]	hdu	HDU index moved to within the lifetime of the guard object (0 is primary).
[in]	relative	If True, interpret hdu as relative to the current HDU rather than an absolute index.

Definition at line 1876 of file fits.cc.

                                                              :
    _fits(fits),
    _oldHdu(_fits.getHdu()),
    _enabled(true)
{
    _fits.setHdu(hdu, relative);
}

~HduMoveGuard()

lsst::afw::fits::HduMoveGuard::~HduMoveGuard

(

)

Definition at line 1884 of file fits.cc.

                            {
    if (!_enabled) {
        return;
    }
    int status = 0;
    std::swap(status, _fits.status);  // unset error indicator, but remember the old status
    try {
        _fits.setHdu(_oldHdu);
    } catch (...) {
        LOGL_WARN(
            "afw.fits",
            makeErrorMessage(_fits.fptr, _fits.status, "Failed to move back to HDU %d").c_str(),
            _oldHdu
        );
    }
    std::swap(status, _fits.status);  // reset the old status
}

Member Function Documentation

disable()

void lsst::afw::fits::HduMoveGuard::disable ( )

inline

Disable the guard, leaving the HDU at its current state at destruction.

Definition at line 733 of file fits.h.

{ _enabled = false; }

operator=() [1/2]

HduMoveGuard & lsst::afw::fits::HduMoveGuard::operator= ( HduMoveGuard && )

delete

operator=() [2/2]

HduMoveGuard & lsst::afw::fits::HduMoveGuard::operator= ( HduMoveGuard const & )

delete

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/fits.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/afw/g7ae74a0b1c+a25e60b391/src/fits.cc