Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
PrevUpHomeNext

BOOST_FUSION_DEFINE_STRUCT

Description

BOOST_FUSION_DEFINE_STRUCT is a macro that can be used to generate all the necessary boilerplate to define and adapt an arbitrary struct as a model of Random Access Sequence.

Synopsis
BOOST_FUSION_DEFINE_STRUCT(
    (namespace0)(namespace1)...,
    struct_name,
    (member_type0, member_name0)
    (member_type1, member_name1)
    ...
    )

Notation

str

An instance of struct_name

e0...en

Heterogeneous values

fs

A Forward Sequence

Expression Semantics

The above macro generates the necessary code that defines and adapts struct_name as a model of Random Access Sequence. The sequence (namespace0)(namespace1)... declares the namespace for struct_name. It yields to a fully qualified name for struct_name of namespace0::namespace1::... struct_name. If an empty namespace sequence is given (that is a macro that expands to nothing), the struct is placed in the global namespace. The sequence of (member_typeN, member_nameN) pairs declares the type and names of each of the struct members that are part of the sequence.

The macro should be used at global scope. Semantics of an expression is defined only where it differs from, or is not defined in Random Access Sequence.

Expression

Semantics

struct_name()

Creates an instance of struct_name with default constructed elements.

struct_name(e0, e1,... en)

Creates an instance of struct_name with elements e0...en.

struct_name(fs)

Copy constructs an instance of struct_name from a Forward Sequence fs.

str = fs

Assigns from a Forward Sequence fs.

str.member_nameN

Access of struct member member_nameN

Header
#include <boost/fusion/adapted/struct/define_struct.hpp>
#include <boost/fusion/include/define_struct.hpp>
Example
// demo::employee is a Fusion sequence
BOOST_FUSION_DEFINE_STRUCT(
    (demo), employee,
    (std::string, name)
    (int, age))

PrevUpHomeNext