Macros.h File Reference

#include "ConstructorMacros.h"
#include "ExcitationMacros.h"
#include "bio/chemical/common/BondTypes.h"
#include "bio/physical/macro/Macros.h"

Include dependency graph for chemical/macro/Macros.h:

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

Go to the source code of this file.

Macros
#define	BIO_GET_REQUIRED_CLASS_METHODS_FOR_chemical()
#define	BIO_GET_OPTIONAL_CLASS_METHODS_FOR_chemical()
#define	BIO_CHEMICAL_BOND_TYPE_FUNCTION_BODY(functionName)
#define	BIO_DIFFUSION_TIME_FUNCTION_BODY(functionName)
#define	BIO_DIFFUSION_EFFORT_FUNCTION_BODY(functionName)

Macro Definition Documentation

BIO_CHEMICAL_BOND_TYPE_FUNCTION_BODY

#define BIO_CHEMICAL_BOND_TYPE_FUNCTION_BODY

(

functionName

)

Value:

BIO_ID_FUNCTION_BODY(                                                          \
    functionName,                                                              \
    ::bio::BondTypePerspective::Instance(),                                    \
    ::bio::BondType)

To make defining BondTypes easier, use this macro to define the function body of your BondType Function(). This will assign a value to a string that is identical to your FunctionName e.g. SafelyAccess<BondTypePerspective>()->GetNameFromId(Value()) would give "Value".

BIO_DIFFUSION_EFFORT_FUNCTION_BODY

#define BIO_DIFFUSION_EFFORT_FUNCTION_BODY

(

functionName

)

Value:

BIO_ID_FUNCTION_BODY(                                                          \
    functionName,                                                              \
    ::bio::DiffusionEffortPerspective::Instance(),                             \
    ::bio::DiffusionEffort)

Make defining DiffusionEfforts easier.

BIO_DIFFUSION_TIME_FUNCTION_BODY

#define BIO_DIFFUSION_TIME_FUNCTION_BODY

(

functionName

)

Value:

BIO_ID_FUNCTION_BODY(                                                          \
    functionName,                                                              \
    ::bio::DiffusionTimePerspective::Instance(),                               \
    ::bio::DiffusionTime)

Make defining DiffusionTimes easier.

BIO_GET_OPTIONAL_CLASS_METHODS_FOR_chemical

#define BIO_GET_OPTIONAL_CLASS_METHODS_FOR_chemical

(

)

Value:

    BIO_GET_OPTIONAL_CLASS_METHODS_FOR_physical(),                             \
    (                                                                          \
        virtual ::bio::Code Attenuate(                                        \
            ::bio::Pointer< const ::bio::physical::Wave > other),             \
        Attenuate(other)                                                       \
    ),                                                                         \
    (                                                                          \
        virtual ::bio::Code Disattenuate(                                     \
            ::bio::Pointer< const ::bio::physical::Wave > other),             \
        Disattenuate(other)                                                    \
    )

Get all virtual methods defined by chemical::Class.

Returns

function signatures for use in BIO_DISAMBIGUATE_ALL_CLASS_METHODS

BIO_GET_REQUIRED_CLASS_METHODS_FOR_chemical

#define BIO_GET_REQUIRED_CLASS_METHODS_FOR_chemical

(

)

Value:

    BIO_GET_REQUIRED_CLASS_METHODS_FOR_physical(),                             \
    (                                                                          \
        virtual bool RegisterProperties(const ::bio::Properties& properties),  \
        RegisterProperties(properties)                                         \
    ),                                                                         \
    (                                                                          \
        virtual ::bio::Properties GetProperties() const,                       \
        GetProperties()                                                        \
    ),                                                                         \
    (                                                                          \
        template< typename AS > operator AS(),                                 \
        template As< AS >()                                                    \
    ),                                                                         \
    (                                                                          \
        virtual ::bio::Pointer< const ::bio::log::Writer > AsLogWriter() const,\
        AsLogWriter()                                                          \
    ),                                                                         \
    (                                                                          \
        BIO_SINGLE_ARG(virtual void Log(                                       \
        ::bio::LogLevel level,                                                 \
        const char *format,                                                    \
        va_list args                                                           \
        ) const),                                                              \
        Log(level, format, args)                                               \
    )

Get all virtual methods defined by chemical::Class.

Returns

function signatures for use in BIO_DISAMBIGUATE_ALL_CLASS_METHODS