IMP logo
IMP Reference Guide  develop.b708a66810,2021/08/02
The Integrative Modeling Platform
decorator_macros.h File Reference

Helper macros for implementing Decorators. More...

#include <IMP/kernel_config.h>
#include "particle_index.h"
#include "Particle.h"
#include "Decorator.h"
#include <IMP/check_macros.h>
#include <IMP/log_macros.h>
#include <IMP/showable_macros.h>
#include <IMP/warning_macros.h>
+ Include dependency graph for decorator_macros.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define IMP_CHECK_DECORATOR(Name, function)   IMP::internal::ParticleCheck Name##pc(Name::get_is_setup, function);
 
#define IMP_CONSTRAINT_DECORATOR_DECL(Name)
 
#define IMP_CONSTRAINT_DECORATOR_DEF(Name)
 
#define IMP_DECORATOR_GET(AttributeKey, Type, has_action, not_has_action)
 Perform actions dependent on whether a particle has an attribute. More...
 
#define IMP_DECORATOR_GET_SET(name, AttributeKey, Type, ReturnType)
 Define methods for getting and setting a particular simple field. More...
 
#define IMP_DECORATOR_GET_SET_OPT(name, AttributeKey, Type, ReturnType, default_value)
 Define methods for getting and setting an optional simple field. More...
 
#define IMP_DECORATOR_METHODS(Name, Parent)
 
#define IMP_DECORATOR_SET(AttributeKey, value)
 Set an attribute, creating it if it does not already exist. More...
 
#define IMP_DECORATOR_SETUP_0(Name)
 
#define IMP_DECORATOR_SETUP_1(Name, FirstArgumentType, first_argument_name)
 
#define IMP_DECORATOR_SETUP_2(Name, FirstArgumentType, first_argument_name,SecondArgumentType, second_argument_name)
 
#define IMP_DECORATOR_SETUP_3(Name, FirstArgumentType, first_argument_name,SecondArgumentType, second_argument_name,ThirdArgumentType, third_argument_name)
 
#define IMP_DECORATOR_SETUP_4(Name, FirstArgumentType, first_argument_name,SecondArgumentType, second_argument_name,ThirdArgumentType, third_argument_name,FourthArgumentType, fourth_argument_name)
 
#define IMP_DECORATOR_SETUP_5(Name,FirstArgumentType, first_argument_name,SecondArgumentType, second_argument_name,ThirdArgumentType, third_argument_name,FourthArgumentType, fourth_argument_name,FifthArgumentType, fifth_argument_name)
 
#define IMP_DECORATOR_TRAITS_SETUP_0(Name)
 
#define IMP_DECORATOR_TRAITS_SETUP_1(Name, FirstArgumentType,first_argument_name)
 
#define IMP_DECORATOR_TRAITS_SETUP_2(Name, FirstArgumentType,first_argument_name, SecondArgumentType, second_argument_name)
 
#define IMP_DECORATOR_WITH_TRAITS_METHODS(Name, Parent, TraitsType,traits_name, default_traits)
 
#define IMP_DECORATORS(Name, PluralName, Parent)
 Define the types for storing sets of decorators. More...
 
#define IMP_DECORATORS_DECL(Name, PluralName)
 
#define IMP_DECORATORS_DEF(Name, PluralName)
 
#define IMP_DECORATORS_WITH_TRAITS(Name, PluralName, Parent)
 Define the types for storing sets of decorators. More...
 
#define IMP_SUMMARIZE_DECORATOR_DECL(Name, Parent, Members, SetupDoc)
 Create a decorator that computes some sort of summary info on a set. More...
 
#define IMP_SUMMARIZE_DECORATOR_DEF(Name, Parent, Members,create_pre_modifier,create_post_modifier)
 

Detailed Description

Helper macros for implementing Decorators.

Copyright 2007-2021 IMP Inventors. All rights reserved.

Definition in file decorator_macros.h.

Macro Definition Documentation

#define IMP_CHECK_DECORATOR (   Name,
  function 
)    IMP::internal::ParticleCheck Name##pc(Name::get_is_setup, function);

Register a function that can be used to check that the particle is valid with respect to the decorator. The function should take a Particle* as an argument and return a bool. It should throw an exception if something is wrong.

This macro should only be used in a .cpp file.

Definition at line 490 of file decorator_macros.h.

#define IMP_CONSTRAINT_DECORATOR_DECL (   Name)

Declares Decorator methods that allows (privately) setting a constraint and publicly getting that constraint

Definition at line 434 of file decorator_macros.h.

#define IMP_CONSTRAINT_DECORATOR_DEF (   Name)

Defines Decorator methods that allows (privately) setting a constraint and publicly getting that constraint. The constraint is added as a score state to the model.

Definition at line 458 of file decorator_macros.h.

#define IMP_DECORATOR_GET (   AttributeKey,
  Type,
  has_action,
  not_has_action 
)

Perform actions dependent on whether a particle has an attribute.

A common pattern is to check if a particle has a particular attribute, do one thing if it does and another if it does not. This macro implements that pattern. It requires that the method get_particle_index() return the particle being used.

Parameters
[in]AttributeKeyThe key for the attribute
[in]TypeThe type for the attribute ("Int", "Float", "String")
[in]has_actionThe action to take if the Particle has the attribute. The attribute value is stored in the variable VALUE.
[in]not_has_actionThe action to take if the Particle does not have the attribute.
See Also
IMP_DECORATOR_GET()
IMP_DECORATOR_GET_SET()

Definition at line 322 of file decorator_macros.h.

#define IMP_DECORATOR_GET_SET (   name,
  AttributeKey,
  Type,
  ReturnType 
)

Define methods for getting and setting a particular simple field.

This macro defines methods to get and set a particular attribute.

Parameters
[in]nameThe lower case name of the attribute
[in]AttributeKeyThe AttributeKey object controlling the attribute.
[in]TypeThe type of the attribute (upper case).
[in]ReturnTypeThe type to return from the get.
See Also
IMP_DECORATOR_GET()
IMP_DECORATOR_SET()

Definition at line 360 of file decorator_macros.h.

#define IMP_DECORATOR_GET_SET_OPT (   name,
  AttributeKey,
  Type,
  ReturnType,
  default_value 
)

Define methods for getting and setting an optional simple field.

See IMP_DECORATOR_GET_SET(). The difference is that here you can provide a default value to use if the decorator does not have the attribute.

Parameters
[in]nameThe lower case name of the attribute
[in]AttributeKeyThe expression to get the required attribute key.
[in]TypeThe type of the attribute (upper case).
[in]ReturnTypeThe type to return from the get.
[in]default_valueThe value returned if the attribute is missing.

Definition at line 382 of file decorator_macros.h.

#define IMP_DECORATOR_METHODS (   Name,
  Parent 
)

Implement the needed methods for a decorator based on

  • setup_particle()
  • get_is_setup() methods that you provide.

Definition at line 25 of file decorator_macros.h.

#define IMP_DECORATOR_SET (   AttributeKey,
  value 
)

Set an attribute, creating it if it does not already exist.

Another common pattern is to have an assumed value if the attribute is not there. Then, you sometimes need to set the value whether it is there or not.

See Also
IMP_DECORATOR_GET()
IMP_DECORATOR_GET_SET()

Definition at line 340 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_0 (   Name)

Decorators need to be able to be set up from Particles, ParticleIndexes and other Decorators. To help keep things uniform, we provide macros to declare the setup functions. These macros expect that an appropriate do_setup_particle(Model *, ParticleIndex, args...) function is defined.

Definition at line 109 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_1 (   Name,
  FirstArgumentType,
  first_argument_name 
)
See Also
IMP_DECORATOR_SETUP_0()

Definition at line 123 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_2 (   Name,
  FirstArgumentType,
  first_argument_name,
  SecondArgumentType,
  second_argument_name 
)
See Also
IMP_DECORATOR_SETUP_0()

Definition at line 142 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_3 (   Name,
  FirstArgumentType,
  first_argument_name,
  SecondArgumentType,
  second_argument_name,
  ThirdArgumentType,
  third_argument_name 
)
See Also
IMP_DECORATOR_SETUP_0()

Definition at line 162 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_4 (   Name,
  FirstArgumentType,
  first_argument_name,
  SecondArgumentType,
  second_argument_name,
  ThirdArgumentType,
  third_argument_name,
  FourthArgumentType,
  fourth_argument_name 
)
See Also
IMP_DECORATOR_SETUP_0()

Definition at line 186 of file decorator_macros.h.

#define IMP_DECORATOR_SETUP_5 (   Name,
  FirstArgumentType,
  first_argument_name,
  SecondArgumentType,
  second_argument_name,
  ThirdArgumentType,
  third_argument_name,
  FourthArgumentType,
  fourth_argument_name,
  FifthArgumentType,
  fifth_argument_name 
)
See Also
IMP_DECORATOR_SETUP_0()

Definition at line 215 of file decorator_macros.h.

#define IMP_DECORATOR_TRAITS_SETUP_0 (   Name)

Decorators need to be able to be set up from Particles, ParticleIndexes and other Decorators. To help keep things uniform, we provide macros to declare the setup functions. These macros expect that an appropriate do_setup_particle(Model *, ParticleIndex, args...) function is defined. But any docs needed before the macro invocation.

Definition at line 254 of file decorator_macros.h.

#define IMP_DECORATOR_TRAITS_SETUP_1 (   Name,
  FirstArgumentType,
  first_argument_name 
)
See Also
IMP_DECORATOR_TRAITS_SETUP_0()

Definition at line 269 of file decorator_macros.h.

#define IMP_DECORATOR_TRAITS_SETUP_2 (   Name,
  FirstArgumentType,
  first_argument_name,
  SecondArgumentType,
  second_argument_name 
)
See Also
IMP_DECORATOR_TRAITS_SETUP_0()

Definition at line 286 of file decorator_macros.h.

#define IMP_DECORATOR_WITH_TRAITS_METHODS (   Name,
  Parent,
  TraitsType,
  traits_name,
  default_traits 
)

Implement the needed methods for a decorator based on

  • setup_particle()
  • get_is_setup() methods that you provide.

Definition at line 60 of file decorator_macros.h.

#define IMP_DECORATORS (   Name,
  PluralName,
  Parent 
)
Value:
IMP_DECORATORS_DECL(Name, PluralName); \
IMP_DECORATORS_DEF(Name, PluralName)

Define the types for storing sets of decorators.

The macro defines the types PluralName and PluralNameTemp. Parent is unused and remains for backward compatibility

Definition at line 414 of file decorator_macros.h.

#define IMP_DECORATORS_DECL (   Name,
  PluralName 
)
Value:
class Name; \
typedef IMP::Vector<Name> PluralName
A more IMP-like version of the std::vector.
Definition: Vector.h:40

Definition at line 395 of file decorator_macros.h.

#define IMP_DECORATORS_WITH_TRAITS (   Name,
  PluralName,
  Parent 
)

Define the types for storing sets of decorators.

The macro defines the types PluralName and PluralNameTemp.

Definition at line 421 of file decorator_macros.h.

#define IMP_SUMMARIZE_DECORATOR_DECL (   Name,
  Parent,
  Members,
  SetupDoc 
)

Create a decorator that computes some sort of summary info on a set.

Examples include a centroid or a cover for a set of particles.

Parameters
[in]NameThe name for the decorator
[in]Parentthe parent decorator type
[in]Membersthe way to pass a set of particles in
[in]SetupDocextra documentation for setup

Definition at line 502 of file decorator_macros.h.

#define IMP_SUMMARIZE_DECORATOR_DEF (   Name,
  Parent,
  Members,
  create_pre_modifier,
  create_post_modifier 
)
See Also
IMP_SUMMARIZE_DECORATOR_DECL()
Parameters
[in]NameThe name for the decorator
[in]Parentthe parent decorator type
[in]Membersthe way to pass a set of particles in
[in]create_pre_modifierthe statements to create the SingletonModifier which computes the summary info, using refiner 'ref'
[in]create_post_modifiera SingletonDerivativeModifier for the derivatives of the summary back to its members, using refiner 'ref'

Definition at line 556 of file decorator_macros.h.