|
Isis 3.0 Developer's Reference (API) |
Home |
Generic Binary Control Net File Representation. More...
#include <ControlNetFile.h>
Inherited by Isis::ControlNetFileV0001, and Isis::ControlNetFileV0002.
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). | |
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.
| Isis::ControlNetFile::ControlNetFile | ( | ) | [inline] |
Constructor.
No data so this does nothing.
| virtual Isis::ControlNetFile::~ControlNetFile | ( | ) | [inline, virtual] |
Destructor.
No data so this does nothing.
| 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).
| 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::ControlNetFileV0001, and Isis::ControlNetFileV0002.
| virtual Pvl Isis::ControlNetFile::ToPvl | ( | ) | const [pure virtual] |
Convert the binary representation to Pvl (any pvl version).
Implemented in Isis::ControlNetFileV0001, and Isis::ControlNetFileV0002.
| 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).
| file | The filename of the binary file to be written |
Implemented in Isis::ControlNetFileV0001, and Isis::ControlNetFileV0002.