• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
3  "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
4<!--
5    Copyright 2003, Eric Friedman, Itay Maman.
6
7    Distributed under the Boost Software License, Version 1.0. (See accompanying
8    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
9-->
10<header name="boost/variant/static_visitor.hpp">
11  <namespace name="boost">
12
13    <class name="static_visitor">
14      <template>
15        <template-type-parameter name="ResultType"/>
16      </template>
17
18      <purpose>Convenient base type for static visitors.</purpose>
19      <description>
20        <simpara>Denotes the intent of the deriving class as meeting the
21          requirements of a static visitor of some type. Also exposes the
22          inner type <code>result_type</code> as required by the
23          <link linkend="variant.concepts.static-visitor"><emphasis>StaticVisitor</emphasis></link>
24          concept.</simpara>
25        <simpara><emphasis role="bold">Notes</emphasis>:
26          <code>static_visitor</code> is intended for use as a base type only
27          and is therefore noninstantiable.</simpara>
28      </description>
29
30      <typedef name="result_type">
31        <type>ResultType</type>
32        <purpose>Exposes result_type member as required by StaticVisitor concept.</purpose>
33      </typedef>
34    </class>
35
36  </namespace>
37</header>
38