dl::IDebugControl Class Reference

An abstract interface that gives users access to debug logging controls. More...

#include <dlapi.h>

Public Types
enum	Setting { Enable , Count , Last = Enable , First = Enable }

Public Member Functions
virtual void	setDebugSetting (IDebugControl::Setting setting, int val)=0
	Sets debug setting value.
virtual int	getDebugSetting (IDebugControl::Setting setting) const =0
	Gets a debug setting value.
virtual bool	hasDebugSetting (IDebugControl::Setting setting) const =0
	Check if the IDebugControl instance supports a debug setting.

Detailed Description

An abstract interface that gives users access to debug logging controls.

See also

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:

++
      auto pGateway = getGateway();
      auto pDebugCtrl = dynamic_cast<IDebugControl*>(pGateway);
      if (pDebugCtrl != nullptr)
      {
           // Enable debug logging (on request)
           pDebugCtrl->setDebugControl(Enable, 1);
      }

Member Enumeration Documentation

Setting

enum dl::IDebugControl::Setting

Enumerator
Enable	Enable: 0 = off, otherwise = on (getDebugSetting returns 1)
Count
Last
First

                     {
            Enable, 
 
            Count,
            Last = Enable,
            First = Enable
        };

Member Function Documentation

getDebugSetting()

virtual int dl::IDebugControl::getDebugSetting ( IDebugControl::Setting setting ) const

pure virtual

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.

See also

setDebugSetting(), hasDebugSetting When retrieving values from the IDebugControl instance, you should always check to see if the setting is supported:

++
          if (pDebugCtrl->hasDebugSetting(setting)
          {
               auto value = pDebugCtrl->getDebugSetting(setting);
               // Do stuff ...
          }

hasDebugSetting()

virtual bool dl::IDebugControl::hasDebugSetting ( IDebugControl::Setting setting ) const

pure virtual

Check if the IDebugControl instance supports a debug setting.

Parameters

setting

The setting to check

Returns

true if supported, false otherwise.

See also

getDebugSetting(), setDebugSetting Check to see if the setting is supported by calling this function as follows:

++
          if (pDebugCtrl->hasDebugSetting(setting)
          {
               auto value = pDebugCtrl->getDebugSetting(setting);
               // Do stuff ...
          }

setDebugSetting()

virtual void dl::IDebugControl::setDebugSetting ( IDebugControl::Setting setting, int val )

pure virtual

Sets debug setting value.

Parameters

setting	The setting to change
val	the value to write for the setting provided in parameter 1

See also

getDebugSetting(), hasDebugSetting

---

The documentation for this class was generated from the following file:

• C:/Users/arobi/Perforce/nightly/DL_Imaging/Aluma_Software/dlapi/src/dlapi.h