DEIMOS
Earth Observation Mission CFI Software
DataHandling Software User Manual		 ESA
Public Member Functions | Public Attributes

EECFI::StfFile Class Reference

Class for reading/writing Swath Template Files. More...

Inheritance diagram for EECFI::StfFile:
EECFI::EEFile EECFI::CfiClass

List of all members.

Public Member Functions

 StfFile ()
 Default constructor.
 StfFile (const std::string &fileNam)
 Constructor file name.
 StfFile (const StfFile &stfFile)
 ~StfFile () NOEXCEPT
 Destructor.
StfFile & operator= (const StfFile &other)
void read ()
 Read the whole file data block.
void readVhr ()
 Read the STF variable header.
void write (const std::string &fileName, const FixedHeader &fixedHead, const StfVhr &stfVhr, const std::vector< StfRec > &stfData)
 Write STF file with a given name.
void write (const FixedHeader &fixedHead, const StfVhr &stfVhr, const std::vector< StfRec > &stfData)
 Write STF file with the file name stored in the object.

Public Attributes

std::vector< StfRec > stfRec
 Vector of swath points.
StfVhr * vhr
 Variable header data.

Detailed Description

Class for reading/writing Swath Template Files.

Constructor & Destructor Documentation

EECFI::StfFile::StfFile (  ) 

Default constructor.

EECFI::StfFile::StfFile ( const std::string &  fileNam  )  [explicit]

Constructor file name.

EECFI::StfFile::StfFile ( const StfFile &  stfFile  ) 

Copy constructor.

Parameters:
other The StfFile to copy from
EECFI::StfFile::~StfFile (  ) 

Destructor.

References vhr.

Member Function Documentation

StfFile & EECFI::StfFile::operator= ( const StfFile &  other  ) 

Copy assignment operator.

Parameters:
other The StfFile to copy/assign from

References vhr.

void EECFI::StfFile::read (  ) 

Read the whole file data block.

References EECFI::EEFile::fileName, stfRec, EECFI::CfiClass::throwWarn, and vhr.

void EECFI::StfFile::readVhr (  ) 

Read the STF variable header.

References EECFI::EEFile::fileName, EECFI::CfiClass::throwWarn, and vhr.

void EECFI::StfFile::write ( const std::string &  fileNam,
const FixedHeader &  fixedHead,
const StfVhr &  stfVhr,
const std::vector< StfRec > &  stfData 
)

Write STF file with a given name.

Parameters:
fileNam Name of the file to write.
fixedHead Values of the fixed header.
stfVhr STF variable header values.
stfData Vector of swath points.

References EECFI::EEFile::fileName.

void EECFI::StfFile::write ( const FixedHeader &  fixedHead,
const StfVhr &  stfVhr,
const std::vector< StfRec > &  stfData 
)

Write STF file with the file name stored in the object.

Parameters:
fixedHead Values of the fixed header.
stfVhr STF variable header values.
stfData Vector of swath points.

References EECFI::StfVhr::absOrbit, EECFI::StfVhr::altitude, EECFI::FixedHeader::creationDate, EECFI::FixedHeader::creator, EECFI::FixedHeader::creatorVersion, EECFI::StfVhr::cycleLength, EECFI::FixedHeader::fileClass, EECFI::FixedHeader::fileDescription, EECFI::EEFile::fileName, EECFI::FixedHeader::fileName, EECFI::FixedHeader::fileType, EECFI::EEFile::fixedHeader, EECFI::StfVhr::frequency, EECFI::StfVhr::geometryFlag, EECFI::FixedHeader::mission, EECFI::StfVhr::mlstDrift, EECFI::StfVhr::numPoints, EECFI::StfVhr::orbitStart, EECFI::StfVhr::orbitStop, EECFI::StfVhr::position, EECFI::StfVhr::ReferenceOSF, EECFI::StfVhr::ReferenceSDF, EECFI::StfVhr::refractionMode, EECFI::StfVhr::repCycle, EECFI::FixedHeader::schema, EECFI::StfVhr::stfName, stfRec, EECFI::StfVhr::swathPointType, EECFI::StfVhr::swathType, EECFI::FixedHeader::system, EECFI::CfiClass::throwWarn, EECFI::StfVhr::timeStep, EECFI::FixedHeader::valStartDate, EECFI::FixedHeader::valStopDate, EECFI::StfVhr::velocity, EECFI::FixedHeader::version, and vhr.

Member Data Documentation

std::vector<StfRec> EECFI::StfFile::stfRec

Vector of swath points.

Referenced by read(), and write().

StfVhr* EECFI::StfFile::vhr

Variable header data.

Referenced by operator=(), read(), readVhr(), write(), and ~StfFile().

Generated on Mon Dec 11 2023 13:28:17 for by doxygen 1.7.1