VHISTlib  1.84.0.3018
UNVHISTLib

Introduction

UNVHISTLib is a library designed to make it easy to access the content of VHIST files. It's written in C++ using datatypes and methods from the Qt 4 Core Libraries. The library contains classes and functions to open and parse VHIST files as well as validate and extract their content.

Overview

The central part of the UNVHISTLib is the vhist::VhistParser class. It is used to open and parse VHIST files. It is your gateway to VHIST files and is probably utilized in every application that uses UNVHISTLib. The class provides the user of the library with a listing of the content of the opened VHIST file, i.e. the information from the VHIST tags in the VHIST file. A VHIST file is split in several sections (which can be accessed using vhist::VhistParser::getSections()), each containing a list of embedded files (use vhist::VhistParser::getFiles() or it's related functions).

The last embedded file in each section is the summary file of this section, names "ws_summary.xml".It contains all meta information about the related section. In the context of a summary files, a section is called a workflowstep. The information inside a summary file is usually much more yielding than the information in the tags and each sophisticated application dealing with VHIST files should consider using this information.

If you want to retrieve the additional information of the summary files, it is neccessary to first extract the summary files and then identify their content with the embedded file tags in the section. These two steps are performed by the vhist::SummaryCreator class.

In a first step, it tries to extract summary files for all sections in the VHIST file and in a second pass associates them with matching tags. The matching is done using a method which will still succeed if the information in either the tags or the summary file are lightly corrupted or the information in both diverges slightly.

Types and Functions:


VHISTlib 1.84.0.3018 of Jun 28 2013, generated by doxygen.