FCloser< T > Struct Template Reference

Template definition for classes that help closing resources. More...

#include <fcleanup.h>

Public Member Functions
	FCloser (T *_obj)
	Constructor. More...
	~FCloser ()
	Destructor. Calls the close function on the at construction time passed pointer. More...

Public Attributes
T *	obj
	Remembers the pointer on which close is to be called during destruction. More...

Detailed Description

template<class T>
struct Steinberg::FCloser< T >

Template definition for classes that help closing resources.

A stack allocated object of this type automatically calls the close method of an at construction time passed object when it reaches the end of its scope. It goes without saying that the given type needs to have a close method.

Intended usage:

struct CloseableObject
{
    void close() {};
};
 
{
    CloseableObject theObject;
    Steinberg::FCloser<CloseableObject> theCloser (&theObject);
 
    // Do something.
 
} // Here the destructor of theCloser calls the close method of theObject.

Constructor & Destructor Documentation

FCloser()

FCloser ( T *  _obj )

inline

Constructor.

_obj is the pointer on which close is to be called when this FCloser object's destructor is executed.

~FCloser()

~FCloser ( )

inline

Destructor. Calls the close function on the at construction time passed pointer.

Member Data Documentation

obj

T* obj

Remembers the pointer on which close is to be called during destruction.