Print Table of Contents

Contents

This example demonstrates how to open an SDRC Universal file and display its table of contents using the Library Manager interface. We’ll walk through the process step by step, showing you how to initialize the library manager, open a file, and print a complete table of contents.

Overview

The example performs the following main tasks:

1. Parse command line arguments, and validate license
2. Open the file using Library Manager
3. Check for errors and handle them appropriately
4. Print the complete table of contents
5. Clean up resources

Let’s examine each step in detail.

Step 1: Initialize and Setup

First, we include necessary headers, declare variables, and handle command line arguments:

C

#include "sam/base/base.h"
#include "sam/vdm/vdm.h"
#include "sam/base/license.h"
#include "sam/hoops_license.h"

int main(int argc, char** argv)
{
    char inputFile[256];
    /* check input arguments */
    if (argc < 2) {
        fprintf(stderr, "Usage: %s inputfile [appendfile]\n", argv[0]);
        fprintf(stderr, " inputfile is blank, 'bumper.unv' is assumed\n");
        strcpy(inputFile, "bumper.unv");
    }
    else {
        strcpy(inputFile, argv[1]);
    }

    vsy_LicenseValidate(HOOPS_LICENSE);

The program provides helpful information about all the datasets in the “bumper.unv” file which is provided along with the SDK. The license is validated using the vsy_LicenseValidate() function.

Step 2: Open File with Library Manager

Next, we create a Library Manager and open the input file:

C

/* Open file */
vdm_LMan* libraryManager = vdm_LManBegin();
vdm_LManOpenFile(libraryManager, inputFile, nullptr);

The LMan (Library Manager) provides a high-level interface for file operations, automatically detecting the file format and initializing the appropriate library based on the file format. A nullptr is provided instead of options since we are not interested in any particular options or conventions while reading this file.

Step 3: Error Checking

After opening the file, we check for any errors and handle them appropriately:

C

/* check for error */
Vint ierr = vdm_LManError(libraryManager);
if (ierr) {
    fprintf(stderr, "Error: opening file %s\n", inputFile);
    vdm_LManCloseFile(libraryManager);
    vdm_LManEnd(libraryManager);
    exit(1);
}

Proper error checking is essential when working with file operations. The Library Manager provides a simple error checking mechanism through vdm_LManError().

Step 4: Print Table of Contents

Now we use the Library Manager’s built-in table of contents function:

C

vdm_LManSetParami(libraryManager, LMAN_VERBOSE, SYS_ON);
vdm_LManTOC(libraryManager, "*");

The vdm_LManSetParami() function is used to configure the Library Manager’s behavior. In this case, we set the LMAN_VERBOSE parameter to SYS_ON, which enables detailed output formatting for the table of contents. This provides the dataset attribute information. Then, vdm_LManTOC() provides a complete table of contents for the file. The “*” parameter is a wildcard that requests information about all datasets. You can also use specific patterns like “D.N*” to get only displacement datasets for each iteration/timestep.

Step 5: Cleanup

Finally, we close the file and free all allocated resources:

C

vdm_LManCloseFile(libraryManager);
vdm_LManEnd(libraryManager);
return 0;

The Library Manager interface requires only two cleanup calls: vdm_LManCloseFile() to close the file and vdm_LManEnd() to free the Library Manager object.

Expected Output

When you run this example with a typical Universal file, you’ll see a comprehensive table of contents output similar to:

Library Table of Contents
Path: bumper.unv
Type: SDRC/IDEAS Universal File
IDst         LRec  NRow     NCol Type NAtt  Dataset
    0          200     1      200    1    2  PARAMETER.INT.T
                Model = Parameters
        Description = Model Integer Parameters
    1          200     1      200    3    2  PARAMETER.HOL.T
                Model = Parameters
        Description = Model Hollerith Parameters
    2         1956     3      652    2    4  X.N
                Model = Mesh
        Description = Node Coordinates
            Contents = Position
            DataType = Vector
    3          652     1      652    1    2  NID.N
                Model = Mesh
        Description = Node User Identifier

Complete Source Code

The complete source code for this example can be found at: src/sam/vdm/exam/exam1.cpp

You can also view the full source here:

#include "sam/base/base.h"
#include "sam/vdm/vdm.h"
#include "sam/base/license.h"
#include "sam/hoops_license.h"

/*----------------------------------------------------------------------
                      Print Table of Contents
----------------------------------------------------------------------*/
int
main(int argc, char** argv)
{
    char inputFile[256];
    /* check input arguments */
    if (argc < 2) {
        fprintf(stderr, "Usage: %s inputfile [appendfile]\n", argv[0]);
        fprintf(stderr, " inputfile is blank, 'bumper.unv' is assumed\n");
        strcpy(inputFile, "bumper.unv");
    }
    else {
        strcpy(inputFile, argv[1]);
    }

    vsy_LicenseValidate(HOOPS_LICENSE);

    /* Open file */
    vdm_LMan* libraryManager = vdm_LManBegin();
    vdm_LManOpenFile(libraryManager, inputFile, nullptr);

    /* check for error */
    Vint ierr = vdm_LManError(libraryManager);
    if (ierr) {
        fprintf(stderr, "Error: opening file %s\n", inputFile);
        vdm_LManCloseFile(libraryManager);
        vdm_LManEnd(libraryManager);
        exit(1);
    }
    /* Set verbose mode */
    vdm_LManSetParami(libraryManager, LMAN_VERBOSE, SYS_ON);
    vdm_LManTOC(libraryManager, "*");

    vdm_LManCloseFile(libraryManager);
    vdm_LManEnd(libraryManager);
    return 0;
}