Navigation

  • index
  • next |
  • previous |
  • QHG4 4.1 documentation »
  • Code Documentation »
  • io »
  • NavWriter

NavWriter¶

This page desctibes the class NavWriter

The class NavWriter is used to write the navigation data to the navigation group in a qdf file.

Code:
NavWriter.h
NavWriter.cpp

Public Methods¶

constructor¶

NavWriter(Navigation *pNav);

The constructor.

write¶

int write(hid_t hFile);

Write the navigation data to an open qdf file.

hFile

HDF handle to the opened file.

writeToQDF¶

int writeToQDF(const std::string sFileName, int iStep,
              float fStartTime,            const std::string sInfoString);

Creates a new qdf file, creates a navigation group and writes the navigation data to it.

sFileName

Name of output file.

iStep

The current simulation step. This number is saved as an attribute in the output file’s root group.

fStartTime

The start time of the simulation (i.e. the ‘real’ time at step 0). This number is also saved as an attribute in the output file’s root group.

sInfoString

An arbitrary string which will be saved as an attribute in the output file’s root group.

Returns 0 on success, -1 on failure.

Protected Methods¶

writeNavAttributes¶

int writeNavAttributes(hid_t hNavGroup);

Writes the navigation attributes to the navigation group in the qdf file.

hNavGroup

HDF pointer to the navigation group in the qdf file.

Returns 0 on success, -1 on failure.

Table of Contents

  • NavWriter
    • Public Methods
      • constructor
      • write
      • writeToQDF
    • Protected Methods
      • writeNavAttributes

Previous topic

VegWriter

Next topic

PopWriter

This Page

  • Show Source

Quick search

Navigation

  • index
  • next |
  • previous |
  • QHG4 4.1 documentation »
  • Code Documentation »
  • io »
  • NavWriter
© Copyright 2022, jodyxha. Created using Sphinx 8.1.3.