Coin: SoProfilingReportGenerator.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoProfilingReportGenerator.h
1#ifndef COIN_SOPROFILINGREPORTGENERATOR_H
2#define COIN_SOPROFILINGREPORTGENERATOR_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbBasic.h>
37#include <Inventor/lists/SbList.h>
38
39class SbProfilingData;
40class SbProfilingReportSortCriteria; // opaque internal
41class SbProfilingReportPrintCriteria; // opaque internal
42
43 class COIN_DLL_API SoProfilingReportGenerator {
44public:
45 static void init(void);
46
47 enum Column {
48 NAME,
49 TYPE,
50 COUNT,
51 TIME_SECS,
52 TIME_SECS_MAX,
53 TIME_SECS_AVG,
54 TIME_MSECS,
55 TIME_MSECS_MAX,
56 TIME_MSECS_AVG,
57 TIME_PERCENT,
58 TIME_PERCENT_MAX,
59 TIME_PERCENT_AVG,
60 MEM_BYTES,
61 MEM_KILOBYTES,
62 GFX_MEM_BYTES,
63 GFX_MEM_KILOBYTES
64 };
65
66 enum SortOrder {
67 TIME_ASC,
68 TIME_DES,
69 TIME_MAX_ASC,
70 TIME_MAX_DES,
71 TIME_AVG_ASC,
72 TIME_AVG_DES,
73 COUNT_ASC,
74 COUNT_DES,
75 ALPHANUMERIC_ASC,
76 ALPHANUMERIC_DES,
77 MEM_ASC,
78 MEM_DES,
79 GFX_MEM_ASC,
80 GFX_MEM_DES
81 };
82
83 enum DataCategorization {
84 TYPES,
85 NAMES,
86 NODES
87 };
88
89 enum CallbackResponse {
90 CONTINUE,
91 STOP
92 };
93
94 static SbProfilingReportSortCriteria * getReportSortCriteria(const SbList< SortOrder > & order);
95 static SbProfilingReportSortCriteria * getDefaultReportSortCriteria(DataCategorization category);
96
97 static SbProfilingReportPrintCriteria * getReportPrintCriteria(const SbList< Column > & order);
98 static SbProfilingReportPrintCriteria * getDefaultReportPrintCriteria(DataCategorization category);
99 static void freeCriteria(SbProfilingReportSortCriteria * criteria);
100 static void freeCriteria(SbProfilingReportPrintCriteria * criteria);
101
102 typedef CallbackResponse ReportCB(void * userdata, int entrynum, const char * text);
103
104 static void generate(const SbProfilingData & data,
105 DataCategorization categorization,
106 SbProfilingReportSortCriteria * sort,
107 SbProfilingReportPrintCriteria * print,
108 int count,
109 SbBool addheader,
110 ReportCB * reportcallback,
111 void * userdata);
112
113 static CallbackResponse stdoutCB(void * userdata, int entrynum, const char * text);
114 static CallbackResponse stderrCB(void * userdata, int entrynum, const char * text);
115
116}; // SoProfilingReportGenerator
117
118#endif // !COIN_SOPROFILINGREPORTGENERATOR_H
SbList
The SbList class is a template container class for lists.
Definition SbList.h:70
SbProfilingData
Data structure for gathering scene graph traversal profiling information.
Definition SbProfilingData.h:52
SoProfilingReportGenerator
Convenience report generator functionality.
Definition SoProfilingReportGenerator.h:43
SoProfilingReportGenerator::init
static void init(void)
Definition SoProfilingReportGenerator.cpp:400
SoProfilingReportGenerator::getDefaultReportPrintCriteria
static SbProfilingReportPrintCriteria * getDefaultReportPrintCriteria(DataCategorization category)
Definition SoProfilingReportGenerator.cpp:327
SoProfilingReportGenerator::getDefaultReportSortCriteria
static SbProfilingReportSortCriteria * getDefaultReportSortCriteria(DataCategorization category)
Definition SoProfilingReportGenerator.cpp:200
SoProfilingReportGenerator::stdoutCB
static CallbackResponse stdoutCB(void *userdata, int entrynum, const char *text)
Definition SoProfilingReportGenerator.cpp:1456
SoProfilingReportGenerator::getReportPrintCriteria
static SbProfilingReportPrintCriteria * getReportPrintCriteria(const SbList< Column > &order)
Definition SoProfilingReportGenerator.cpp:253
SoProfilingReportGenerator::stderrCB
static CallbackResponse stderrCB(void *userdata, int entrynum, const char *text)
Definition SoProfilingReportGenerator.cpp:1468
SoProfilingReportGenerator::generate
static void generate(const SbProfilingData &data, DataCategorization categorization, SbProfilingReportSortCriteria *sort, SbProfilingReportPrintCriteria *print, int count, SbBool addheader, ReportCB *reportcallback, void *userdata)
Definition SoProfilingReportGenerator.cpp:427
SoProfilingReportGenerator::getReportSortCriteria
static SbProfilingReportSortCriteria * getReportSortCriteria(const SbList< SortOrder > &order)
Definition SoProfilingReportGenerator.cpp:133