Isis::ControlNetFile Class Reference

Generic Binary Control Net File Representation. More...

#include <ControlNetFile.h>

Inheritance diagram for Isis::ControlNetFile:

Collaboration diagram for Isis::ControlNetFile:

Public Member Functions
	ControlNetFile ()
	Constructor.
virtual	~ControlNetFile ()
	Destructor.
virtual void	Read (const Pvl &header, const FileName &file)=0
	This reads the binary file into memory.
virtual void	Write (const FileName &file) const =0
	This writes the binary file that is in memory to disk.
virtual Pvl	toPvl () const =0
	Convert the binary representation to Pvl (any pvl version).

Private Member Functions
	ControlNetFile (const ControlNetFile &other)
	Disallow copy construction.
ControlNetFile &	operator= (const ControlNetFile &other)
	Disallow assignment.

Detailed Description

Generic Binary Control Net File Representation.

This class is the parent for all binary forms of the control network files. Each one must be readable, writable, and convertable to Pvl. Other than that, they can be (and probably will be) literally anything as long as it has a Pvl header.

Author

2011-04-07 Steven Lambright

Definition at line 20 of file ControlNetFile.h.

Constructor & Destructor Documentation

Isis::ControlNetFile::ControlNetFile ( )

inline

Constructor.

No data so this does nothing.

Definition at line 25 of file ControlNetFile.h.

virtual Isis::ControlNetFile::~ControlNetFile ( )

inlinevirtual

Destructor.

No data so this does nothing.

Definition at line 29 of file ControlNetFile.h.

Isis::ControlNetFile::ControlNetFile ( const ControlNetFile &  other )

private

Disallow copy construction.

This should never happen.

Parameters

other

File to copy from

Member Function Documentation

ControlNetFile& Isis::ControlNetFile::operator= ( const ControlNetFile &  other )

private

Disallow assignment.

This should never happen.

Parameters

other

File to copy from

virtual void Isis::ControlNetFile::Read ( const Pvl &  header, const FileName &  file  )

pure virtual

This reads the binary file into memory.

The header is the Pvl that must be at the top of the file (it's how we could tell it was binary in the first place).

Parameters

header	The pvl at the top of the file down to the "End" keyword
file	The filename of the binary file to be read

Implemented in Isis::ControlNetFileV0002, and Isis::ControlNetFileV0001.

Referenced by Isis::ControlNetVersioner::ReadBinaryNetwork().

virtual Pvl Isis::ControlNetFile::toPvl ( ) const

pure virtual

Convert the binary representation to Pvl (any pvl version).

Implemented in Isis::ControlNetFileV0001, and Isis::ControlNetFileV0002.

Referenced by Isis::ControlNetVersioner::ReadBinaryNetwork().

virtual void Isis::ControlNetFile::Write ( const FileName &  file ) const

pure virtual

This writes the binary file that is in memory to disk.

The behavior of this method is undefined if the required data is not set (ControlNetVersioner::LatestPvlToBinary guarantees they are, and this should never be called for old versions).

Parameters

file	The filename of the binary file to be written

Implemented in Isis::ControlNetFileV0001, and Isis::ControlNetFileV0002.

---

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

• src/control/objs/ControlNetVersioner/ControlNetFile.h