MrSID Decode SDK for Raster Reference Manual  9.5.5.5244
lt_utilStatusData.h
Go to the documentation of this file.
1 //
2 // This code is property of Celartem, Inc dba Extensis.
3 // Copyright (c) 1995-2023. All rights reserved.
4 // Use permitted only under license from Extensis.
5 //
6 /* PUBLIC */
7 
8 #ifndef LT_UTILSTATUSDATA_H
9 #define LT_UTILSTATUSDATA_H
10 
11 // lt_lib_base
12 #include "lt_base.h"
13 
14 LT_BEGIN_LIZARDTECH_NAMESPACE
15 
16 class LTFileSpec;
17 
18 
82 {
83 public:
95 
105 
106  // returns true iff initialize() was called, e.g. system is being used
107  static bool isActive();
108 
109  // push data associated with an error onto the error frame stack
110  // do begin(), data..., end()
111  static void pushBegin(LT_STATUS status);
112  static void pushContext(LT_STATUS status, const char *context);
113  static void pushUint32(lt_uint32 value);
114  static void pushInt32(lt_int32 value);
115  static void pushString(const char *value);
116  static void pushDouble(double value);
117  static void pushFileSpec(const LTFileSpec &value);
118  static void pushEnd();
119 
120  // get the top data item off the error frame stack
121  // returns failure if the data itemis not of the specified type
122  static LT_STATUS popBegin(LT_STATUS &status);
123  static LT_STATUS popContext(const char *&context);
124  static LT_STATUS popString(char *&value); // caller takes ownership of string
125  static LT_STATUS popEnd();
126 
127  // remove the current error frame, if any (this is like doing the pop
128  // begin/end sequence, if there is an active frame)
129  static void clear();
130 
131  class ErrorState;
132 };
133 
134 
135 LT_END_LIZARDTECH_NAMESPACE
136 
137 #endif // LT_UTILSTATUSDATA_H
Include file for all LizardTech sources.
lt_uint32 LT_STATUS
An integral status code.
Definition: lt_status.h:30
unsigned int lt_uint32
unsigned 32-bit integer
Definition: lt_types.h:44
signed int lt_int32
signed 32-bit integer
Definition: lt_types.h:42
Represents a file or directory path.
Definition: lt_fileSpec.h:35
Interface to the error data stack.
static void pushEnd()
static LT_STATUS popEnd()
static void pushInt32(lt_int32 value)
static void pushString(const char *value)
static LT_STATUS popString(char *&value)
static LT_STATUS initialize()
initialize the error stack
static bool isActive()
static void pushDouble(double value)
static LT_STATUS terminate()
cleanup
static void pushContext(LT_STATUS status, const char *context)
static void pushFileSpec(const LTFileSpec &value)
static void clear()
static void pushUint32(lt_uint32 value)
static void pushBegin(LT_STATUS status)
static LT_STATUS popBegin(LT_STATUS &status)
static LT_STATUS popContext(const char *&context)

Extensis