IMP  2.1.0
The Integrative Modeling Platform
base/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 base/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(Name)
 
#define IMP_OBJECT_2(Name)
 
#define IMP_OBJECT_INLINE(Name, show, destructor)
 
#define IMP_OBJECT_METHODS(Name)
 Define the basic things needed by any Object. More...
 
#define IMP_OBJECT_NO_WARNING(Name)
 Only to work aroung a gcc bug.
 
#define IMP_OBJECTS(Name, PluralName)
 Define the types for storing sets of objects. More...
 

Detailed Description

Copyright 2007-2013 IMP Inventors. All rights reserved.

Definition in file base/object_macros.h.

Macro Definition Documentation

#define IMP_NEW (   Typename,
  varname,
  args 
)    IMP::base::Pointer<Typename> varname(new Typename args)
Parameters
[in]TypenameThe namespace qualified type being declared
[in]varnameThe name for the ref counted pointer
[in]argsThe 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 100 of file base/object_macros.h.

#define IMP_OBJECT (   Name)
Value:
public: \
IMPBASE_DEPRECATED_MACRO(2.1, "Use IMP_OBJECT_METHODS() instead."); \
#define IMP_OBJECT_NO_WARNING(Name)
Only to work aroung a gcc bug.
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP_OBJECT_METHODS()

Definition at line 62 of file base/object_macros.h.

#define IMP_OBJECT_2 (   Name)
Value:
IMP_DEPRECATED_MACRO(2.0, "Use IMP_OBJECT_METHODS() macro") \
#define IMP_OBJECT_METHODS(Name)
Define the basic things needed by any Object.
#define IMP_DEPRECATED_MACRO(version, help_message)
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP_OBJECT_METHODS()

Definition at line 68 of file base/object_macros.h.

#define IMP_OBJECT_INLINE (   Name,
  show,
  destructor 
)
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use IMP_OBJECT_METHODS()

Definition at line 34 of file base/object_macros.h.

#define IMP_OBJECT_METHODS (   Name)

This defines

Definition at line 25 of file base/object_macros.h.

#define IMP_OBJECTS (   Name,
  PluralName 
)

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

Definition at line 77 of file base/object_macros.h.