ISISDLM::iFile Class Reference

#include <iFile.h>

Public Types
typedef unsigned long	Iid
	Definition of ID type.

Public Member Functions
std::string	name () const
Iid	getId () const
bool	readOnly () const
Isis::Cube *	Cube () const
Isis::Pvl *	Pvl () const
void	Flush ()

Protected Member Functions
	iFile ()
	iFile (const std::string &filename, Isis::Cube *cube, bool readonly=true)
	iFile (const std::string &filename, Isis::Pvl *pvl, bool readonly=true)
virtual	~iFile ()

Private Member Functions
	iFile (const iFile &f)
iFile	operator= (const iFile &f)
Iid	new_id ()

Private Attributes
Iid	_iid
	Unique identifier.
bool	_readonly
	Input/Output status.
Isis::Cube *	_cube
	ISIS cube file definition/pointer.
Isis::Pvl *	_pvl
	PVL label/file pointer.
std::string	_filename
	Name of file.

Static Private Attributes
static Iid	_iid_counter = 0
	Maintains unique id.

Friends
class	FileRepository

Detailed Description

Specification of internal ISIS elements for tracking purposes This specification tracks an ISIS cube, its label, its identifier and a good bit of information regarding its status.

This structure supports just a PVL label that is independant of an ISIS cube file. This allows use cases for creating and maintaining only PVL files.

Version:

Id:

iFile.h,v 1.4 2004/11/02 15:38:53 kbecker Exp

Member Typedef Documentation

typedef unsigned long ISISDLM::iFile::Iid

Definition of ID type.

Constructor & Destructor Documentation

ISISDLM::iFile::iFile ( )

protected

ISISDLM::iFile::iFile ( const std::string &  filename, Isis::Cube *  cube, bool  readonly = true  )

protected

ISISDLM::iFile::iFile ( const std::string &  filename, Isis::Pvl *  pvl, bool  readonly = true  )

protected

ISISDLM::iFile::~iFile ( )

protectedvirtual

References _cube, _pvl, and Flush().

Here is the call graph for this function:

ISISDLM::iFile::iFile ( const iFile &  f )

private

Member Function Documentation

Isis::Cube* ISISDLM::iFile::Cube ( ) const

inline

References _cube.

Referenced by ISISDLM::isis_create(), ISISDLM::isis_query(), ISISDLM::isis_read_brick(), ISISDLM::isis_read_image(), ISISDLM::isis_write_image(), and ISISDLM::show_file_data().

void ISISDLM::iFile::Flush

(

)

References _filename, _pvl, and _readonly.

Referenced by ~iFile().

Iid ISISDLM::iFile::getId ( ) const

inline

References _iid.

Referenced by ISISDLM::FileRepository::addCube(), ISISDLM::FileRepository::addPvl(), and ISISDLM::show_file_data().

std::string ISISDLM::iFile::name ( ) const

inline

References _filename.

Referenced by ISISDLM::isis_query(), ISISDLM::isis_read_blob(), ISISDLM::isis_read_brick(), ISISDLM::isis_read_image(), ISISDLM::isis_write_image(), and ISISDLM::show_file_data().

Iid ISISDLM::iFile::new_id ( )

inlineprivate

References _iid_counter.

iFile ISISDLM::iFile::operator= ( const iFile &  f )

private

Isis::Pvl * ISISDLM::iFile::Pvl

(

)

const

References _cube, and _pvl.

Referenced by ISISDLM::isis_get_key(), and ISISDLM::isis_query_key().

bool ISISDLM::iFile::readOnly ( ) const

inline

References _readonly.

Friends And Related Function Documentation

friend class FileRepository

friend

Member Data Documentation

Isis::Cube* ISISDLM::iFile::_cube

private

ISIS cube file definition/pointer.

Referenced by Cube(), Pvl(), and ~iFile().

std::string ISISDLM::iFile::_filename

private

Name of file.

Referenced by Flush(), and name().

Iid ISISDLM::iFile::_iid

private

Unique identifier.

Referenced by getId().

iFile::Iid ISISDLM::iFile::_iid_counter = 0

staticprivate

Maintains unique id.

Initialize the internal instance of itself.

Referenced by new_id().

Isis::Pvl* ISISDLM::iFile::_pvl

private

PVL label/file pointer.

Referenced by Flush(), Pvl(), and ~iFile().

bool ISISDLM::iFile::_readonly

private

Input/Output status.

Referenced by Flush(), and readOnly().

---

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

• iFile.h
• iFile.cpp