Navigation

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

NavGroupReader¶

This page describes the class NavGroupReader

The class NavGroupReader reads attributes and arrays from the navigation group of a qdf file.

This file extends the attribute structure:

struct NavAttributes : Attributes {
    uint     m_iNumPorts;
    uint     m_iNumDests;
    uint     m_iNumDists;
    double   m_dSampleDist;
    uint     m_iNumBridges;
};
Code:
NavGroupReader.h
NavGroupReader.cpp

Public Methods¶

createNavGroupReader¶

static NavGroupReader *createNavGroupReader(const std::string sFileName);
static NavGroupReader *createNavGroupReader(hid_t hFile);

Creates a NavGroupReader object for a qdf file.

sFileName

Name of the file to read the navigation data from.

hFile

HDF5 handle for the file to read the navigation data from.

Returns a pointer to the NavGroupReader object or NULL on failure.

tryReadAttributes¶

virtual int tryReadAttributes(NavAttributes *pAttributes);

Reads the attributes “NumCells”, “NumPorts”, “NumDests”, “SampleDist” and “NumBridges” in the navigation group into the attribute structure.

pAttributes

A pointer to a NavAttributes object to hold the attributes.

Returns 0 on succes, or -1 on failure.

readArray¶

virtual int readArray(Navigation *pNavigation, const std::string sArrayName);

Read the specified array from the “Navigation” group of the qdf file.

pNavigation

A pointer to the Navigation object into which to read the array,

sArrayName

Name of the array in the “Navigation” group of the qdf file.

Returns 0 on succes, or -1 on failure.

readData¶

virtual int readData(Navigation *pNavigation);

Reads the arrays “Multiplicities”, “DestIDs”, and “Distances”.

pNavigation

A Pointer to a Navigation object.

Returns 0 on succes, or -1 on failure.

Protected Methods¶

constructor¶

NavGroupReader();

The constructor.

Table of Contents

  • NavGroupReader
    • Public Methods
      • createNavGroupReader
      • tryReadAttributes
      • readArray
      • readData
    • Protected Methods
      • constructor

Previous topic

VegGroupReader

Next topic

PopReader

This Page

  • Show Source

Quick search

Navigation

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