Results Access#

In this example we will demonstrate how to:

Access all raw calculation results for a selected result type
Retrieve processed (GUI-style) result tables with just key data
Work with both result types as DataFrames for easy data handling and export

from dlubal.api import rstab, common

with rstab.Application() as rstab_app:

    # --- get_results ---
    # Retrieves complete, unprocessed results from the RSTAB database.
    # These results are returned wrapped in a DataFrame (.Data).
    results:common.Table = rstab_app.get_results(
        results_type=rstab.results.ResultsType.STATIC_ANALYSIS_MEMBERS_INTERNAL_FORCES
    )
    print(f"\nResults:\n{results.data}")



    #--- get_result_table ---
    # Retrieves a pre-processed result table wrapped in a DataFrame (.Data),
    # containing only the most relevant values as displayed in the RSTAB desktop application.
    result_table:common.Table = rstab_app.get_result_table(
        table = rstab.results.ResultTable.STATIC_ANALYSIS_MEMBERS_INTERNAL_FORCES_TABLE,
        loading= rstab.ObjectId(
            no=1,
            object_type=rstab.OBJECT_TYPE_LOAD_COMBINATION
        )
    )
    print(f"\nResult Table:\n{result_table.data}")

    # --- has_results ---
    # Checks if results exist for a specified loading condition.
    # This is useful to confirm results availability before retrieving them,
    # preventing errors or unnecessary data requests.
    has_results = rstab_app.has_results(
        loading = rstab.ObjectId
        (
            no = 1,
            object_type = rstab.OBJECT_TYPE_LOAD_COMBINATION,
        )
    )
    print(f"\nResults Available: {has_results.value}")

using Rstab = Dlubal.Api.Rstab;
using Common = Dlubal.Api.Common;


ApplicationRstab? RstabApp = null;

try
{
    RstabApp = new ApplicationRstab();

    // --- get_results ---
    // Retrieves complete, unprocessed results from the RSTAB database.
    // These results are returned wrapped in a DataFrame (.Data).
    Common.Table results = await RstabApp.get_results(
        resultsType: Rstab.Results.ResultsType.StaticAnalysisMembersInternalForces
    );
    Console.WriteLine($"\nResults:\n{results.Data}");

    // --- get_result_table ---
    // Retrieves a pre-processed result table wrapped in a DataFrame (.Data),
    // containing only the most relevant values as displayed in the RSTAB desktop application.
    Common.Table resultTable = await RstabApp.get_result_table(
        table: Rstab.Results.ResultTable.StaticAnalysisMembersInternalForcesTable,
        loading: new Rstab.ObjectId
        {
            No = 1,
            ObjectType = Rstab.ObjectType.LoadCombination
        }
    );
    Console.WriteLine($"\nResult Table:\n{resultTable.Data}");


    // --- has_results ---
    // Checks if results exist for a specified loading condition.
    // This is useful to confirm results availability before retrieving them,
    // preventing errors or unnecessary data requests.
    var hasResults = await RstabApp.has_results(
        loading: new Rstab.ObjectId
        {
            No = 1,
            ObjectType = Rstab.ObjectType.LoadCombination,
        }
    );
    Console.WriteLine($"\nResults Available: {hasResults}");

}
catch (Exception ex)
{
    Console.WriteLine($"Error: {ex.Message}");
}
finally
{
    if (RstabApp != null) await RstabApp.close_connection();
}