A FITS header unit. More...

#include <FitsCard.h>

Inheritance diagram for Basda::VinoFitsCardBox:

Collaboration diagram for Basda::VinoFitsCardBox:

Public Member Functions
void	set (const Basda::VinoFitsCard &_card)
	add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them. More...

void	set (const std::string &_key, const std::string &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const char *_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, int _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, bool _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, size_t _precision, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const VinoFitsCardBox &_box)
	add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist. More...

VinoFitsCard	get (const std::string &_key)
	search for a key in the existing card set More...

int	write (fitsfile *)
	insert all cards into a header-data unit More...

size_t	size () const
	number of cards in the set More...

void	read (const std::string &_filename)
	read a file that contains ASCII template cards, one per line More...

VinoFitsCardBox &	merge (const VinoFitsCardBox &_fbox)
	Merge Basda::VinoFitsCardBox merge into this. More...

void	set (const Basda::VinoFitsCard &_card)
	add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them. More...

void	set (const std::string &_key, const std::string &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const char *_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, int _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, bool _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, size_t _precision, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const VinoFitsCardBox &_box)
	add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist. More...

VinoFitsCard	get (const std::string &_key)
	search for a key in the existing card set More...

int	write (fitsfile *)

size_t	size () const
	number of cards in the set More...

void	read (const std::string &_filename)

VinoFitsCardBox &	merge (const VinoFitsCardBox &_fbox)

void	set (const Basda::VinoFitsCard &_card)
	add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them. More...

void	set (const std::string &_key, const std::string &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const char *_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, int _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, bool _val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const std::string &_key, const double &_val, size_t _precision, const std::string &_comment)
	add a card to the stack. If a card with the same key exists, it is replaced. More...

void	set (const VinoFitsCardBox &_box)
	add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist. More...

VinoFitsCard	get (const std::string &_key)
	search for a key in the existing card set More...

int	write (fitsfile *)

size_t	size () const
	number of cards in the set More...

void	read (const std::string &_filename)

VinoFitsCardBox &	merge (const VinoFitsCardBox &_fbox)

Public Member Functions inherited from Basda::VinoFitsCardBoxVar
bool	operator== (const VinoFitsCardBoxVar &__rhs) const

bool	operator< (const VinoFitsCardBoxVar &__rhs) const

bool	operator!= (const VinoFitsCardBoxVar &__rhs) const

bool	operator<= (const VinoFitsCardBoxVar &__rhs) const

bool	operator> (const VinoFitsCardBoxVar &__rhs) const

bool	operator>= (const VinoFitsCardBoxVar &__rhs) const

bool	operator== (const VinoFitsCardBoxVar &__rhs) const

bool	operator< (const VinoFitsCardBoxVar &__rhs) const

bool	operator!= (const VinoFitsCardBoxVar &__rhs) const

bool	operator<= (const VinoFitsCardBoxVar &__rhs) const

bool	operator> (const VinoFitsCardBoxVar &__rhs) const

bool	operator>= (const VinoFitsCardBoxVar &__rhs) const

Protected Member Functions
SeqVinoFitsCardVarIterator	find (const std::string &)
	search for a key More...

SeqVinoFitsCardVarIterator	find (const std::string &)

SeqVinoFitsCardVarIterator	find (const std::string &)

Additional Inherited Members
Public Attributes inherited from Basda::VinoFitsCardBoxVar
::Basda::SeqVinoFitsCardVar	mdata

Detailed Description

A FITS header unit.

A set of FITS header cards in a FITS header.

Member Function Documentation

◆ find() [1/3]

Basda::SeqVinoFitsCardVarIterator Basda::VinoFitsCardBox::find ( const std::string & _key )

protected

search for a key

Parameters

_key	The key to be found in the cards

Returns: The position of the key. The end() value if the key is not found.

◆ find() [2/3]

SeqVinoFitsCardVarIterator Basda::VinoFitsCardBox::find ( const std::string & )

protected

◆ find() [3/3]

SeqVinoFitsCardVarIterator Basda::VinoFitsCardBox::find ( const std::string & )

protected

◆ get() [1/3]

VinoFitsCard Basda::VinoFitsCardBox::get ( const std::string & _key )

inline

search for a key in the existing card set

Parameters

_key	the key to be searched for

Returns: The card that contains the key. If the key is absent, a void card with zero contents.

◆ get() [2/3]

VinoFitsCard Basda::VinoFitsCardBox::get ( const std::string & _key )

inline

search for a key in the existing card set

Parameters

_key	the key to be searched for

Returns: The card that contains the key. If the key is absent, a void card with zero contents.

◆ get() [3/3]

VinoFitsCard Basda::VinoFitsCardBox::get ( const std::string & _key )

inline

search for a key in the existing card set

Parameters

_key	the key to be searched for

Returns: The card that contains the key. If the key is absent, a void card with zero contents.

◆ merge() [1/3]

VinoFitsCardBox& Basda::VinoFitsCardBox::merge ( const VinoFitsCardBox & _fbox )

◆ merge() [2/3]

VinoFitsCardBox& Basda::VinoFitsCardBox::merge ( const VinoFitsCardBox & _fbox )

◆ merge() [3/3]

Basda::VinoFitsCardBox & Basda::VinoFitsCardBox::merge ( const VinoFitsCardBox & _fbox )

Merge Basda::VinoFitsCardBox merge into this.

Parameters

_fbox the VinoFitsCardBox

Returns: this

◆ read() [1/3]

void Basda::VinoFitsCardBox::read ( const std::string & _filename )

◆ read() [2/3]

void Basda::VinoFitsCardBox::read ( const std::string & _file )

read a file that contains ASCII template cards, one per line

Parameters

_file the name of the ASCII file to be parsed. If the file cannot be read (or does not exist) this is a no-op.

Since: 2017-02-13

◆ read() [3/3]

void Basda::VinoFitsCardBox::read ( const std::string & _filename )

◆ set() [1/24]

void Basda::VinoFitsCardBox::set ( const Basda::VinoFitsCard & _card )

inline

add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them.

Parameters

_card The new header card.

◆ set() [2/24]

void Basda::VinoFitsCardBox::set ( const Basda::VinoFitsCard & _card )

inline

add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them.

Parameters

_card The new header card.

◆ set() [3/24]

void Basda::VinoFitsCardBox::set ( const Basda::VinoFitsCard & _card )

inline

add a card to the stack. If a card with the same key exists, it is replaced, otherwise the new card is appended. So the order of the cards is preserved and follows the order of adding them.

Parameters

_card The new header card.

◆ set() [4/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const std::string &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [5/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const std::string &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [6/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const std::string &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [7/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const char *	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

Since: 2017-02-15

◆ set() [8/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const char *	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

Since: 2017-02-15

◆ set() [9/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const char *	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

Since: 2017-02-15

◆ set() [10/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		int	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [11/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		int	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [12/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		int	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [13/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		bool	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [14/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		bool	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [15/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		bool	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [16/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [17/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [18/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_comment	comment inside the new card

◆ set() [19/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		size_t	_precision,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_precision	precision in the double value
_comment	comment inside the new card

◆ set() [20/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		size_t	_precision,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_precision	precision in the double value
_comment	comment inside the new card

◆ set() [21/24]

void Basda::VinoFitsCardBox::set	(	const std::string &	_key,
		const double &	_val,
		size_t	_precision,
		const std::string &	_comment
	)

inline

add a card to the stack. If a card with the same key exists, it is replaced.

Parameters

_key	keyword of the new card
_val	value of the new card
_precision	precision in the double value
_comment	comment inside the new card

◆ set() [22/24]

void Basda::VinoFitsCardBox::set ( const VinoFitsCardBox & _box )

inline

add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist.

Parameters

_box	The additional cards to be added.

◆ set() [23/24]

void Basda::VinoFitsCardBox::set ( const VinoFitsCardBox & _box )

inline

add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist.

Parameters

_box	The additional cards to be added.

◆ set() [24/24]

void Basda::VinoFitsCardBox::set ( const VinoFitsCardBox & _box )

inline

add the cards of another card box to this one. Cards of the other box replace cards in here if they already exist.

Parameters

_box	The additional cards to be added.

◆ size() [1/3]

size_t Basda::VinoFitsCardBox::size ( ) const

inline

number of cards in the set

Returns: The length of the associated stack representation.

◆ size() [2/3]

size_t Basda::VinoFitsCardBox::size ( ) const

inline

number of cards in the set

Returns: The length of the associated stack representation.

◆ size() [3/3]

size_t Basda::VinoFitsCardBox::size ( ) const

inline

number of cards in the set

Returns: The length of the associated stack representation.

◆ write() [1/3]

int Basda::VinoFitsCardBox::write ( fitsfile * )

◆ write() [2/3]

int Basda::VinoFitsCardBox::write ( fitsfile * )

◆ write() [3/3]

int Basda::VinoFitsCardBox::write ( fitsfile * _file )

insert all cards into a header-data unit

Parameters

_file the current position of the cfitsio representation

Returns: Always -1.

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

/home/nirva/insroot/include/Basda/Vino/FitsCard.h
TwiceAsNice/basda-vino/doc/include/Basda/Vino/FitsCard.cc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ find() [1/3]

◆ find() [2/3]

◆ find() [3/3]

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ merge() [1/3]

◆ merge() [2/3]

◆ merge() [3/3]

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ set() [1/24]

◆ set() [2/24]

◆ set() [3/24]

◆ set() [4/24]

◆ set() [5/24]

◆ set() [6/24]

◆ set() [7/24]

◆ set() [8/24]

◆ set() [9/24]

◆ set() [10/24]

◆ set() [11/24]

◆ set() [12/24]

◆ set() [13/24]

◆ set() [14/24]

◆ set() [15/24]

◆ set() [16/24]

◆ set() [17/24]

◆ set() [18/24]

◆ set() [19/24]

◆ set() [20/24]

◆ set() [21/24]

◆ set() [22/24]

◆ set() [23/24]

◆ set() [24/24]

◆ size() [1/3]

◆ size() [2/3]

◆ size() [3/3]

◆ write() [1/3]

◆ write() [2/3]

◆ write() [3/3]