OptionalExplanations Struct Reference

Convenience wrapper for an Explanations pointer, which can be null if no explanations need to be recorded. More...

#include <explanations.h>

Public Member Functions
void	LookupAndAppend (const void *item, std::vector< std::string > *out)
	OptionalExplanations (Explanations *explanations)
Explanations *	ptr () const
void	Record (const void *item, const char *fmt,...)
void	RecordArgs (const void *item, const char *fmt, va_list args)

Private Attributes
Explanations *	explanations_

Detailed Description

Convenience wrapper for an Explanations pointer, which can be null if no explanations need to be recorded.

Definition at line 61 of file explanations.h.

Constructor & Destructor Documentation

OptionalExplanations()

OptionalExplanations::OptionalExplanations ( Explanations *  explanations )

inline

Definition at line 62 of file explanations.h.

Member Function Documentation

LookupAndAppend()

void OptionalExplanations::LookupAndAppend ( const void *  item, std::vector< std::string > *  out  )

inline

Definition at line 79 of file explanations.h.

References explanations_, and Explanations::LookupAndAppend().

Referenced by TEST().

ptr()

Explanations* OptionalExplanations::ptr ( ) const

inline

Definition at line 84 of file explanations.h.

References explanations_.

Record()

void OptionalExplanations::Record ( const void *  item, const char *  fmt,   ...  )

inline

Definition at line 65 of file explanations.h.

References explanations_, and Explanations::RecordArgs().

Referenced by TEST().

RecordArgs()

void OptionalExplanations::RecordArgs ( const void *  item, const char *  fmt, va_list  args  )

inline

Definition at line 74 of file explanations.h.

References explanations_, and Explanations::RecordArgs().

Member Data Documentation

explanations_

Explanations* OptionalExplanations::explanations_

private

Definition at line 87 of file explanations.h.

Referenced by LookupAndAppend(), ptr(), Record(), and RecordArgs().

---

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

• explanations.h