ScopedTypeVariant类 参考

#include <scopedtypevariant.h>

ScopedTypeVariant 的协作图:

Public 类型
enum	Variant { Global, Local, Dummy }
	possible variant types 更多...

Public 成员函数
	ScopedTypeVariant ()
	default constructor for creating a variant of type Dummy 更多...
	ScopedTypeVariant (const Definition *d)
	constructor for creating a variant of type Global 更多...
	ScopedTypeVariant (const QCString &name)
	constructor for creating a variant of type Local 更多...
	ScopedTypeVariant (const ScopedTypeVariant &stv)
	copy constructor 更多...
	ScopedTypeVariant (ScopedTypeVariant &&stv) noexcept
	move constructor 更多...
ScopedTypeVariant &	operator= (ScopedTypeVariant stv)
	assignment operator 更多...
	~ScopedTypeVariant ()
	destructor 更多...
void	setGlobal (const Definition *def)
	Turn the variant into a Global type 更多...
LocalDef *	setLocal (const QCString &name)
	Turn the variant into a Local type 更多...
void	setDummy ()
	Turn the variant into a Dummy type 更多...
Variant	type () const
QCString	name () const
LocalDef *	localDef () const
const Definition *	globalDef () const

Private 属性
Variant	m_variant
QCString	m_name
union {
const Definition *   globalDef
LocalDef *   localDef
}	m_u

友元
void	swap (ScopedTypeVariant &first, ScopedTypeVariant &second)
	swap function 更多...

详细描述

Variant class for a scoped type.

Variants:

• Dummy: a type used for hiding a global type.
• Local: a locally defined type (e.g. found inside a function)
• Global: a globally defined type (processed by doxygen in an earlier pass).

在文件 scopedtypevariant.h 第 45 行定义.

成员枚举类型说明

Variant

enum ScopedTypeVariant::Variant

possible variant types

枚举值
Global
Local
Dummy

在文件 scopedtypevariant.h 第 49 行定义.

    {
      Global,
      Local,
      Dummy
    };

构造及析构函数说明

ScopedTypeVariant() [1/5]

ScopedTypeVariant::ScopedTypeVariant ( )

inline

default constructor for creating a variant of type Dummy

在文件 scopedtypevariant.h 第 56 行定义.

                        : m_variant(Dummy)
    {
      m_u.globalDef = 0;
    }

引用了 m_u.

ScopedTypeVariant() [2/5]

ScopedTypeVariant::ScopedTypeVariant ( const Definition *  d )

inlineexplicit

constructor for creating a variant of type Global

在文件 scopedtypevariant.h 第 61 行定义.

    {
      if (d)
      {
        m_name = d->name();
        m_variant = Global;
        m_u.globalDef = d;
      }
      else
      {
        m_variant = Dummy;
        m_u.globalDef = 0;
      }
    }

引用了 Dummy, Global, m_name, m_u, m_variant , 以及 Definition::name().

ScopedTypeVariant() [3/5]

ScopedTypeVariant::ScopedTypeVariant ( const QCString &  name )

inlineexplicit

constructor for creating a variant of type Local

在文件 scopedtypevariant.h 第 76 行定义.

    {
      m_name = name;
      m_variant = Local;
      m_u.localDef = new LocalDef;
    }

引用了 Local, m_name, m_u, m_variant , 以及 name().

ScopedTypeVariant() [4/5]

ScopedTypeVariant::ScopedTypeVariant ( const ScopedTypeVariant &  stv )

inline

copy constructor

在文件 scopedtypevariant.h 第 83 行定义.

    {
      m_variant = stv.m_variant;
      m_name    = stv.m_name;
      if (m_variant==Local)
      {
        m_u.localDef = new LocalDef(*stv.m_u.localDef);
      }
      else if (m_variant==Global)
      {
        m_u.globalDef = stv.m_u.globalDef;
      }
    }

引用了 Global, globalDef, Local, localDef, m_name, m_u , 以及 m_variant.

ScopedTypeVariant() [5/5]

ScopedTypeVariant::ScopedTypeVariant ( ScopedTypeVariant &&  stv )

inlinenoexcept

move constructor

在文件 scopedtypevariant.h 第 97 行定义.

                                                        : ScopedTypeVariant()
    {
      swap(*this,stv);
    }

引用了 swap.

~ScopedTypeVariant()

ScopedTypeVariant::~ScopedTypeVariant ( )

inline

destructor

在文件 scopedtypevariant.h 第 108 行定义.

    {
      if (m_variant==Local)
      {
        delete m_u.localDef;
      }
    }

引用了 Local, m_u , 以及 m_variant.

成员函数说明

globalDef()

const Definition* ScopedTypeVariant::globalDef ( ) const

inline

在文件 scopedtypevariant.h 第 160 行定义.

{ return m_variant==Global ? m_u.globalDef : 0; }

引用了 Global, m_u , 以及 m_variant.

localDef()

LocalDef* ScopedTypeVariant::localDef ( ) const

inline

在文件 scopedtypevariant.h 第 159 行定义.

{ return m_variant==Local ? m_u.localDef : 0; }

引用了 Local, m_u , 以及 m_variant.

name()

QCString ScopedTypeVariant::name ( ) const

inline

在文件 scopedtypevariant.h 第 158 行定义.

{ return m_name; }

引用了 m_name.

被这些函数引用 ScopedTypeVariant() , 以及 setLocal().

operator=()

ScopedTypeVariant& ScopedTypeVariant::operator= ( ScopedTypeVariant  stv )

inline

assignment operator

在文件 scopedtypevariant.h 第 102 行定义.

    {
      swap(*this,stv);
      return *this;
    }

引用了 swap.

setDummy()

void ScopedTypeVariant::setDummy ( )

inline

Turn the variant into a Dummy type

在文件 scopedtypevariant.h 第 147 行定义.

    {
      if (m_variant==Local)
      {
        delete m_u.localDef;
      }
      m_variant = Dummy;
      m_name = "";
      m_u.localDef=0;
    }

引用了 Dummy, Local, m_name, m_u , 以及 m_variant.

setGlobal()

void ScopedTypeVariant::setGlobal ( const Definition *  def )

inline

Turn the variant into a Global type

在文件 scopedtypevariant.h 第 124 行定义.

    {
      if (m_variant==Local)
      {
        delete m_u.localDef;
      }
      m_variant = Global;
      m_name = def->name();
      m_u.globalDef = def;
    }

引用了 Global, Local, m_name, m_u, m_variant , 以及 Definition::name().

setLocal()

LocalDef* ScopedTypeVariant::setLocal ( const QCString &  name )

inline

Turn the variant into a Local type

在文件 scopedtypevariant.h 第 135 行定义.

    {
      if (m_variant==Local)
      {
        delete m_u.localDef;
      }
      m_variant = Local;
      m_name = name;
      m_u.localDef = new LocalDef;
      return m_u.localDef;
    }

引用了 Local, m_name, m_u, m_variant , 以及 name().

type()

Variant ScopedTypeVariant::type ( ) const

inline

在文件 scopedtypevariant.h 第 157 行定义.

{ return m_variant; }

引用了 m_variant.

友元及相关函数文档

swap

void swap ( ScopedTypeVariant &  first, ScopedTypeVariant &  second  )

friend

swap function

在文件 scopedtypevariant.h 第 116 行定义.

    {
      using std::swap; // enable ADL
      swap(first.m_variant,second.m_variant);
      swap(first.m_name,second.m_name);
      swap(first.m_u.globalDef,second.m_u.globalDef);
    }

被这些函数引用 operator=() , 以及 ScopedTypeVariant().

类成员变量说明

globalDef

const Definition* ScopedTypeVariant::globalDef

在文件 scopedtypevariant.h 第 167 行定义.

被这些函数引用 ScopedTypeVariant().

localDef

LocalDef* ScopedTypeVariant::localDef

在文件 scopedtypevariant.h 第 168 行定义.

被这些函数引用 ScopedTypeVariant().

m_name

QCString ScopedTypeVariant::m_name

private

在文件 scopedtypevariant.h 第 164 行定义.

被这些函数引用 name(), ScopedTypeVariant(), setDummy(), setGlobal() , 以及 setLocal().

m_u

union { ... } ScopedTypeVariant::m_u

被这些函数引用 globalDef(), localDef(), ScopedTypeVariant(), setDummy(), setGlobal(), setLocal() , 以及 ~ScopedTypeVariant().

m_variant

Variant ScopedTypeVariant::m_variant

private

在文件 scopedtypevariant.h 第 163 行定义.

被这些函数引用 globalDef(), localDef(), ScopedTypeVariant(), setDummy(), setGlobal(), setLocal(), type() , 以及 ~ScopedTypeVariant().

---

该类的文档由以下文件生成:

• src/scopedtypevariant.h