Print Table of Contents

C++C

This example demonstrates how to open an SDRC Universal file and display its table of contents using the DataSource interface. We’ll walk through the process step by step, showing you how to create a data source, open a file, and print a complete table of contents.

Quick Navigation:

• Overview
• Step 1: Initialize and Setup
• Step 2: Open File with DataSource
• Step 3: Error Checking
• Step 4: Print Table of Contents
• Complete Source Code

Overview

The example performs the following main tasks:

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

Let’s examine each step in detail.

Step 1: Initialize and Setup

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

#include "samcpp/core/core.h"
#include "samcpp/access/access.h"
#include "sam/hoops_license.h"
#include <iostream>

/*----------------------------------------------------------------------
                      Print Table of Contents
----------------------------------------------------------------------*/
int
main(int argc, char** argv)
{
    char inputFile[cae::core::MAX_NAME_LENGTH] = {};
    // Check input arguments
    if (argc < 2) {
        std::cerr << "Usage: " << argv[0] << " inputfile [appendfile]\n";
        std::cerr << " inputfile is blank, 'bumper.unv' is assumed\n";
        strcpy(inputFile, "bumper.unv");
    }
    else {
        strcpy(inputFile, argv[1]);
    }

    cae::core::license::validate(HOOPS_LICENSE);

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

Step 2: Open File with DataSource

Next, we create a DataSource and open the input file:

// Open file
cae::access::DataSource dataSource;
cae::core::Status status = dataSource.openFile(inputFile, nullptr);

The DataSource provides a high-level interface for file operations using openFile(). The file format is automatically detected. 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:

// Check for error
if (!status) {
    std::cerr << "Error: opening file " << inputFile << '\n';
    exit(1);
}

Proper error checking is essential when working with file operations. The DataSource’s openFile() method returns a Status object that can be checked for success or failure.

Step 4: Print Table of Contents

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

// Set verbose mode and print table of contents
dataSource.setIntegerParameter(cae::access::DataSource::IntegerParameter::VERBOSE, true);
dataSource.printTableOfContents("*");

The setIntegerParameter() method is used to configure the DataSource’s behavior. In this case, we set the VERBOSE parameter to 1, which enables detailed output formatting for the table of contents. This provides the attribute information of each result. Then, printTableOfContents() provides a complete table of contents for the file. The “*” parameter is a wildcard that requests information about all results. You can also use specific patterns like “D.N*” to get only displacement results for each iteration/timestep.

Complete Source Code

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

You can also view the full source here:

#include "samcpp/core/core.h"
#include "samcpp/access/access.h"
#include "sam/hoops_license.h"
#include <iostream>

/*----------------------------------------------------------------------
                      Print Table of Contents
----------------------------------------------------------------------*/
int
main(int argc, char** argv)
{
    char inputFile[cae::core::MAX_NAME_LENGTH] = {};
    // Check input arguments
    if (argc < 2) {
        std::cerr << "Usage: " << argv[0] << " inputfile [appendfile]\n";
        std::cerr << " inputfile is blank, 'bumper.unv' is assumed\n";
        strcpy(inputFile, "bumper.unv");
    }
    else {
        strcpy(inputFile, argv[1]);
    }

    cae::core::license::validate(HOOPS_LICENSE);

    // Open file
    cae::access::DataSource dataSource;
    cae::core::Status status = dataSource.openFile(inputFile, nullptr);

    // Check for error
    if (!status) {
        std::cerr << "Error: opening file " << inputFile << '\n';
        exit(1);
    }

    // Set verbose mode and print table of contents
    dataSource.setIntegerParameter(cae::access::DataSource::IntegerParameter::VERBOSE, 1);
    dataSource.printTableOfContents("*");

    return 0;
}

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