maliput_deprecated.h File Reference

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

Macros
#define	MALIPUT_DEPRECATED(...)
	Adds "deprecated" attribute to classes, methods, variables, aliases. More...
#define	MALIPUT_DEPRECATED_MSG(message)   MALIPUT_DEPRECATED_MSG_REPLACEMENT(message, "None")
	Auxiliary macro declarations for overloading MALIPUT_DEPRECATED macro. More...
#define	MALIPUT_DEPRECATED_MSG_REPLACEMENT(message, replacement)   MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE(message, replacement, "unkown")
#define	MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE(message, replacement, removal_date)
#define	MALIPUT_GET_DEPRECATED_MACRO(_1, _2, _3, DEPRECATED_MACRO_NAME, ...)   DEPRECATED_MACRO_NAME

Macro Definition Documentation

MALIPUT_DEPRECATED

#define MALIPUT_DEPRECATED

(

...

)

Value:

  MALIPUT_GET_DEPRECATED_MACRO(__VA_ARGS__, MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE,                \
                               MALIPUT_DEPRECATED_MSG_REPLACEMENT, MALIPUT_DEPRECATED_MSG, _UNUSED) \
  (__VA_ARGS__)

Adds "deprecated" attribute to classes, methods, variables, aliases.

_1 : message: Deprecation message. _2 : replacement: Alternative entity suggested to be used. _3 : removal_date: Estimated date for removal.

Example of use:

• Method:

  MALIPUT_DEPRECATED("MyOldMethod will be deprecated")
  int MyOldMethod(int x) {
    // ...
  }

• Class:

  class MALIPUT_DEPRECATED("MyOldClass will be deprecated", "MyNewClass") MyOldClass {
    // ...
  };

• Variable:

  MALIPUT_DEPRECATED("my_old_var will be deprecated")
  static constexpr int my_old_var = 2;

• Type Alias:

  using MyOldAlias MALIPUT_DEPRECATED("MyOldAlias will be deprecated.") = std::map<std::string, double>;

MALIPUT_DEPRECATED_MSG

#define MALIPUT_DEPRECATED_MSG

(

message

)

MALIPUT_DEPRECATED_MSG_REPLACEMENT(message, "None")

Auxiliary macro declarations for overloading MALIPUT_DEPRECATED macro.

Please use ONLY MALIPUT_DEPRECATED().

MALIPUT_DEPRECATED_MSG_REPLACEMENT

#define MALIPUT_DEPRECATED_MSG_REPLACEMENT	(		message,
			replacement
	)		MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE(message, replacement, "unkown")

MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE

#define MALIPUT_DEPRECATED_MSG_REPLACEMENT_DATE	(		message,
			replacement,
			removal_date
	)

Value:

  [[deprecated("MALIPUT DEPRECATED: " message ". " replacement " is an alternative." \
               " Deprecation date is " removal_date ".")]]

MALIPUT_GET_DEPRECATED_MACRO

#define MALIPUT_GET_DEPRECATED_MACRO	(		_1,
			_2,
			_3,
			DEPRECATED_MACRO_NAME,
			...
	)		DEPRECATED_MACRO_NAME