An abstract interface that gives users access to debug logging controls \seealso IGateway, getGateway() If Debug logging is supported, the IGateway pointer returned from getGateway() will inheritt from IDebugControl as well. You can check to see whether the version of DLAPI being used by your application supports these features using a dynamic cast:
More...
#include <dlapi.h>
An abstract interface that gives users access to debug logging controls \seealso IGateway, getGateway() If Debug logging is supported, the IGateway pointer returned from getGateway() will inheritt from IDebugControl as well. You can check to see whether the version of DLAPI being used by your application supports these features using a dynamic cast:
{c++}
auto pDebugCtrl = dynamic_cast<IDebugControl*>(pGateway);
if (pDebugCtrl != nullptr)
{
pDebugCtrl->setDebugControl(
Enable, 1);
}
◆ Setting
Enumerator |
---|
Enable | Enable: 0 = off, otherwise = on (getDebugSetting returns 1)
|
Count | |
Last | |
First | |
Enable: 0 = off, otherwise = on (getDebugSetting returns 1)
Definition: dlapi.h:2209
◆ getDebugSetting()
Gets a debug setting value.
- Parameters
-
setting | The setting to retrieve |
- Returns
- the value of the setting passed in. 0 if the setting is not supported. \seealso setDebugSetting(), hasDebugSetting When retrieving values from the IDebugControl instance, you should always check to see if the setting is supported:
{c++}
if (pDebugCtrl->hasDebugSetting(setting)
{
auto value = pDebugCtrl->getDebugSetting(setting);
}
◆ hasDebugSetting()
Check if the IDebugControl instance supports a debug setting.
- Parameters
-
setting | The setting to check |
- Returns
- true if supported, false otherwise. \seealso getDebugSetting(), setDebugSetting Check to see if the setting is supported by calling this function as follows:
{c++}
if (pDebugCtrl->hasDebugSetting(setting)
{
auto value = pDebugCtrl->getDebugSetting(setting);
}
◆ setDebugSetting()
Sets debug setting value.
- Parameters
-
setting | The setting to change |
val | the value to write for the setting provided in parameter 1 \seealso getDebugSetting(), hasDebugSetting |
The documentation for this class was generated from the following file:
- C:/NightlyBuild/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h