raii_macros.h File Reference

Macros to aid in writing RAII-style classes. More...

#include <IMP/kernel_config.h>
#include "showable_macros.h"
#include "RAII.h"

Include dependency graph for raii_macros.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	IMP_RAII(Name, args, Initialize, Set, Reset, Show)
	Declares RAII-style methods in a class. More...

Detailed Description

Macros to aid in writing RAII-style classes.

Copyright 2007-2021 IMP Inventors. All rights reserved.

Definition in file raii_macros.h.

Macro Definition Documentation

#define IMP_RAII	(		Name,
			args,
			Initialize,
			Set,
			Reset,
			Show
	)

Declares RAII-style methods in a class.

Since such class methods are typically quite small and simple, all the implementation is inline. The macro declares

• default constructor
• explicit constructor
• RAII::set()
• RAII::reset()
• destructor

Parameters

Name	the class name
args	the argument string (in parentheses) for the explicit constructor and set()
Initialize	code called from any constructor, including the default
Set	the code called from the explicit constructor or the set() function
Reset	the code called from the destructor, and in set before calling the Set code
Show	the code for the show() method

Definition at line 34 of file raii_macros.h.