object_macros.h File Reference

Various general useful macros for IMP. More...

#include <IMP/base/base_config.h>
#include "doxygen_macros.h"
#include "ref_counted_macros.h"
#include "Vector.h"
#include "Pointer.h"
#include "WeakPointer.h"
#include "SetLogState.h"

Include dependency graph for object_macros.h:

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

Go to the source code of this file.

Macros
#define	IMP_GENERIC_OBJECT(Name, lcname, targument, carguments, cparguments)
#define	IMP_NEW(Typename, varname, args)   IMP::base::Pointer<Typename> varname(new Typename args)
	Declare a ref counted pointer to a new object. More...
#define	IMP_OBJECT_METHODS(Name)
	Define the basic things needed by any Object. More...
#define	IMP_OBJECT_NO_WARNING(Name)
	Only to work around a gcc bug. More...
#define	IMP_OBJECTS(Name, PluralName)
	Define the types for storing sets of objects. More...

Detailed Description

Various general useful macros for IMP.

Copyright 2007-2014 IMP Inventors. All rights reserved.

Definition in file object_macros.h.

Macro Definition Documentation

#define IMP_NEW	(		Typename,
			varname,
			args
	)		IMP::base::Pointer<Typename> varname(new Typename args)

Declare a ref counted pointer to a new object.

Parameters

[in]	Typename	The namespace qualified type being declared
[in]	varname	The name for the ref counted pointer
[in]	args	The arguments to the constructor, or () if there are none. Please read the documentation for IMP::Pointer before using.

Examples:

core/simple.cpp.

Definition at line 72 of file object_macros.h.

#define IMP_OBJECT_METHODS

(

Name

)

Define the basic things needed by any Object.

This defines

• IMP::base::Object::get_version_info()
• IMP::base::Object::get_type_name()
• a protected destructor

Definition at line 25 of file object_macros.h.

#define IMP_OBJECT_NO_WARNING

(

Name

)

Only to work around a gcc bug.

Definition at line 38 of file object_macros.h.

#define IMP_OBJECTS	(		Name,
			PluralName
	)

Define the types for storing sets of objects.

The macro defines the types PluralName and PluralNameTemp. PluralName should be Names unless the English spelling is different.

Definition at line 52 of file object_macros.h.