Drake
 All Classes Files Functions Variables
WarningManager Class Reference

carry this object around (e.g. More...

Inheritance diagram for WarningManager:
Collaboration diagram for WarningManager:

Public Member Functions

function WarningManager ()
 
function warnOnce (obj, msgid, varargin)
 call this instead of warning to print the warning only once. More...
 
function isDisabled (obj, msgid)
 check if the message is already 'disabled' More...
 
function disableWarning (obj, msgid)
 disable this message type without printing the warning More...
 

Public Attributes

Property disabled_msgids
 

Detailed Description

carry this object around (e.g.

in a class) to allow logic like displaying a warning only once (per instance of that class)

Constructor & Destructor Documentation

function WarningManager ( )
Return values
obj

Member Function Documentation

function disableWarning ( obj  ,
msgid   
)

disable this message type without printing the warning

Parameters
msgidas in warning msgid
function isDisabled ( obj  ,
msgid   
)

check if the message is already 'disabled'

Parameters
msgidas in warning msgid
Return values
tf
function warnOnce ( obj  ,
msgid  ,
varargin   
)

call this instead of warning to print the warning only once.

after calling, the message is 'disabled'

Parameters
msgidas in warning msgid
vararginmessage string + additional info

Member Data Documentation

Property disabled_msgids

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