Collaboration diagram for Code generated by DATATOOL from 'espell.dtd' (module 'espell'):

Classes
class	CESpellResult
	CESpellResult –. More...

class	CESpellResult_Base
	CESpellResult_Base –. More...

class	CSpelledQuery
	CSpelledQuery –. More...

class	CSpelledQuery_Base
	CSpelledQuery_Base –. More...

class	CSpelledQuery_Base::C_Data
	\d+ More...

Typedefs
typedef CESpellResult_Base	CESpellResult::Tparent

typedef NCBI_NS_NCBI::CSerialObject	CESpellResult_Base::Tparent

typedef NCBI_NS_STD::string	CESpellResult_Base::TDatabase

typedef NCBI_NS_STD::string	CESpellResult_Base::TQuery

typedef NCBI_NS_STD::string	CESpellResult_Base::TCorrectedQuery

typedef CSpelledQuery	CESpellResult_Base::TSpelledQuery

typedef NCBI_NS_STD::string	CESpellResult_Base::TERROR

typedef Tparent::CMemberIndex< E_memberIndex, 6 >	CESpellResult_Base::TmemberIndex

typedef CSpelledQuery_Base	CSpelledQuery::Tparent

typedef NCBI_NS_NCBI::CSerialObject	CSpelledQuery_Base::Tparent

typedef NCBI_NS_NCBI::CSerialObject	CSpelledQuery_Base::C_Data::Tparent

typedef NCBI_NS_STD::string	CSpelledQuery_Base::C_Data::TReplaced

typedef NCBI_NS_STD::string	CSpelledQuery_Base::C_Data::TOriginal

typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > >	CSpelledQuery_Base::Tdata

Enumerations
enum class	CESpellResult_Base::E_memberIndex { CESpellResult_Base::e__allMandatory = 0 , CESpellResult_Base::e_Database , CESpellResult_Base::e_Query , CESpellResult_Base::e_CorrectedQuery , CESpellResult_Base::e_SpelledQuery , CESpellResult_Base::e_ERROR }

enum	CSpelledQuery_Base::C_Data::E_Choice { CSpelledQuery_Base::C_Data::e_not_set = 0 , CSpelledQuery_Base::C_Data::e_Replaced , CSpelledQuery_Base::C_Data::e_Original }
	Choice variants. More...

enum	CSpelledQuery_Base::C_Data::E_ChoiceStopper { CSpelledQuery_Base::C_Data::e_MaxChoice = 3 }
	Maximum+1 value of the choice variant enumerator. More...

Functions
	CESpellResult::CESpellResult (void)

	CESpellResult::~CESpellResult (void)

	CESpellResult::CESpellResult (const CESpellResult &value)

CESpellResult &	CESpellResult::operator= (const CESpellResult &value)

	CESpellResult_Base::CESpellResult_Base (void)

virtual	CESpellResult_Base::~CESpellResult_Base (void)

	CESpellResult_Base::DECLARE_INTERNAL_TYPE_INFO ()

bool	CESpellResult_Base::IsSetDatabase (void) const
	\d+ Check if a value has been assigned to Database data member. More...

bool	CESpellResult_Base::CanGetDatabase (void) const
	Check if it is safe to call GetDatabase method. More...

void	CESpellResult_Base::ResetDatabase (void)
	Reset Database data member. More...

const TDatabase &	CESpellResult_Base::GetDatabase (void) const
	Get the Database member data. More...

void	CESpellResult_Base::SetDatabase (const TDatabase &value)
	Assign a value to Database data member. More...

void	CESpellResult_Base::SetDatabase (TDatabase &&value)

TDatabase &	CESpellResult_Base::SetDatabase (void)
	Assign a value to Database data member. More...

bool	CESpellResult_Base::IsSetQuery (void) const
	\d+ Check if a value has been assigned to Query data member. More...

bool	CESpellResult_Base::CanGetQuery (void) const
	Check if it is safe to call GetQuery method. More...

void	CESpellResult_Base::ResetQuery (void)
	Reset Query data member. More...

const TQuery &	CESpellResult_Base::GetQuery (void) const
	Get the Query member data. More...

void	CESpellResult_Base::SetQuery (const TQuery &value)
	Assign a value to Query data member. More...

void	CESpellResult_Base::SetQuery (TQuery &&value)

TQuery &	CESpellResult_Base::SetQuery (void)
	Assign a value to Query data member. More...

bool	CESpellResult_Base::IsSetCorrectedQuery (void) const
	\d+ Check if a value has been assigned to CorrectedQuery data member. More...

bool	CESpellResult_Base::CanGetCorrectedQuery (void) const
	Check if it is safe to call GetCorrectedQuery method. More...

void	CESpellResult_Base::ResetCorrectedQuery (void)
	Reset CorrectedQuery data member. More...

const TCorrectedQuery &	CESpellResult_Base::GetCorrectedQuery (void) const
	Get the CorrectedQuery member data. More...

void	CESpellResult_Base::SetCorrectedQuery (const TCorrectedQuery &value)
	Assign a value to CorrectedQuery data member. More...

void	CESpellResult_Base::SetCorrectedQuery (TCorrectedQuery &&value)

TCorrectedQuery &	CESpellResult_Base::SetCorrectedQuery (void)
	Assign a value to CorrectedQuery data member. More...

bool	CESpellResult_Base::IsSetSpelledQuery (void) const
	\d+ Check if a value has been assigned to SpelledQuery data member. More...

bool	CESpellResult_Base::CanGetSpelledQuery (void) const
	Check if it is safe to call GetSpelledQuery method. More...

void	CESpellResult_Base::ResetSpelledQuery (void)
	Reset SpelledQuery data member. More...

const TSpelledQuery &	CESpellResult_Base::GetSpelledQuery (void) const
	Get the SpelledQuery member data. More...

void	CESpellResult_Base::SetSpelledQuery (TSpelledQuery &value)
	Assign a value to SpelledQuery data member. More...

TSpelledQuery &	CESpellResult_Base::SetSpelledQuery (void)
	Assign a value to SpelledQuery data member. More...

bool	CESpellResult_Base::IsSetERROR (void) const
	\d+ Check if a value has been assigned to ERROR data member. More...

bool	CESpellResult_Base::CanGetERROR (void) const
	Check if it is safe to call GetERROR method. More...

void	CESpellResult_Base::ResetERROR (void)
	Reset ERROR data member. More...

const TERROR &	CESpellResult_Base::GetERROR (void) const
	Get the ERROR member data. More...

void	CESpellResult_Base::SetERROR (const TERROR &value)
	Assign a value to ERROR data member. More...

void	CESpellResult_Base::SetERROR (TERROR &&value)

TERROR &	CESpellResult_Base::SetERROR (void)
	Assign a value to ERROR data member. More...

virtual void	CESpellResult_Base::Reset (void)
	Reset the whole object. More...

	CESpellResult_Base::CESpellResult_Base (const CESpellResult_Base &)

CESpellResult_Base &	CESpellResult_Base::operator= (const CESpellResult_Base &)

	CSpelledQuery::CSpelledQuery (void)

	CSpelledQuery::~CSpelledQuery (void)

	CSpelledQuery::CSpelledQuery (const CSpelledQuery &value)

CSpelledQuery &	CSpelledQuery::operator= (const CSpelledQuery &value)

	CSpelledQuery_Base::CSpelledQuery_Base (void)

virtual	CSpelledQuery_Base::~CSpelledQuery_Base (void)

	CSpelledQuery_Base::DECLARE_INTERNAL_TYPE_INFO ()

	CSpelledQuery_Base::C_Data::C_Data (void)

	CSpelledQuery_Base::C_Data::~C_Data (void)

	CSpelledQuery_Base::C_Data::DECLARE_INTERNAL_TYPE_INFO ()

void	CSpelledQuery_Base::C_Data::Reset (void)
	Reset the whole object. More...

void	CSpelledQuery_Base::C_Data::ResetSelection (void)
	Reset the selection (set it to e_not_set). More...

E_Choice	CSpelledQuery_Base::C_Data::Which (void) const
	Which variant is currently selected. More...

void	CSpelledQuery_Base::C_Data::CheckSelected (E_Choice index) const
	Verify selection, throw exception if it differs from the expected. More...

void	CSpelledQuery_Base::C_Data::ThrowInvalidSelection (E_Choice index) const
	Throw 'InvalidSelection' exception. More...

static NCBI_NS_STD::string	CSpelledQuery_Base::C_Data::SelectionName (E_Choice index)
	Retrieve selection name (for diagnostic purposes). More...

void	CSpelledQuery_Base::C_Data::Select (E_Choice index, NCBI_NS_NCBI::EResetVariant reset=NCBI_NS_NCBI::eDoResetVariant)
	Select the requested variant if needed. More...

void	CSpelledQuery_Base::C_Data::Select (E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool *pool)
	Select the requested variant if needed, allocating CObject variants from memory pool. More...

bool	CSpelledQuery_Base::C_Data::IsReplaced (void) const
	Check if variant Replaced is selected. More...

const TReplaced &	CSpelledQuery_Base::C_Data::GetReplaced (void) const
	Get the variant data. More...

TReplaced &	CSpelledQuery_Base::C_Data::SetReplaced (void)
	Select the variant. More...

void	CSpelledQuery_Base::C_Data::SetReplaced (const TReplaced &value)
	Select the variant and set its data. More...

bool	CSpelledQuery_Base::C_Data::IsOriginal (void) const
	Check if variant Original is selected. More...

const TOriginal &	CSpelledQuery_Base::C_Data::GetOriginal (void) const
	Get the variant data. More...

TOriginal &	CSpelledQuery_Base::C_Data::SetOriginal (void)
	Select the variant. More...

void	CSpelledQuery_Base::C_Data::SetOriginal (const TOriginal &value)
	Select the variant and set its data. More...

	CSpelledQuery_Base::C_Data::C_Data (const C_Data &)

C_Data &	CSpelledQuery_Base::C_Data::operator= (const C_Data &)

void	CSpelledQuery_Base::C_Data::DoSelect (E_Choice index, NCBI_NS_NCBI::CObjectMemoryPool *pool=0)

bool	CSpelledQuery_Base::IsSet (void) const
	Check if a value has been assigned to data member. More...

bool	CSpelledQuery_Base::CanGet (void) const
	Check if it is safe to call Get method. More...

void	CSpelledQuery_Base::Reset (void)
	Reset data member. More...

const Tdata &	CSpelledQuery_Base::Get (void) const
	Get the member data. More...

Tdata &	CSpelledQuery_Base::Set (void)
	Assign a value to data member. More...

	CSpelledQuery_Base::operator const Tdata & (void) const
	Conversion operator to 'const Tdata' type. More...

	CSpelledQuery_Base::operator Tdata & (void)
	Conversion operator to 'Tdata' type. More...

	CSpelledQuery_Base::CSpelledQuery_Base (const CSpelledQuery_Base &)

CSpelledQuery_Base &	CSpelledQuery_Base::operator= (const CSpelledQuery_Base &)

Variables
Uint4	CESpellResult_Base::m_set_State [1]

NCBI_NS_STD::string	CESpellResult_Base::m_Database

NCBI_NS_STD::string	CESpellResult_Base::m_Query

NCBI_NS_STD::string	CESpellResult_Base::m_CorrectedQuery

NCBI_NS_NCBI::CRef< TSpelledQuery >	CESpellResult_Base::m_SpelledQuery

NCBI_NS_STD::string	CESpellResult_Base::m_ERROR

E_Choice	CSpelledQuery_Base::C_Data::m_choice

static const char *const	CSpelledQuery_Base::C_Data::sm_SelectionNames []

NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > CSpelledQuery_Base::C_Data::m_string

void * CSpelledQuery_Base::C_Data::m_dummy_pointer_for_alignment

union {
NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > CSpelledQuery_Base::C_Data::m_string

void * CSpelledQuery_Base::C_Data::m_dummy_pointer_for_alignment

};

Uint4	CSpelledQuery_Base::m_set_State [1]

NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > >	CSpelledQuery_Base::m_data

Detailed Description

Typedef Documentation

◆ TCorrectedQuery

typedef NCBI_NS_STD::string CESpellResult_Base::TCorrectedQuery

Definition at line 89 of file ESpellResult_.hpp.

◆ Tdata

typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > > CSpelledQuery_Base::Tdata

Definition at line 239 of file SpelledQuery_.hpp.

◆ TDatabase

typedef NCBI_NS_STD::string CESpellResult_Base::TDatabase

Definition at line 87 of file ESpellResult_.hpp.

◆ TERROR

typedef NCBI_NS_STD::string CESpellResult_Base::TERROR

Definition at line 91 of file ESpellResult_.hpp.

◆ TmemberIndex

typedef Tparent::CMemberIndex<E_memberIndex, 6> CESpellResult_Base::TmemberIndex

Definition at line 102 of file ESpellResult_.hpp.

◆ TOriginal

typedef NCBI_NS_STD::string CSpelledQuery_Base::C_Data::TOriginal

Definition at line 162 of file SpelledQuery_.hpp.

◆ Tparent [1/5]

typedef CESpellResult_Base CESpellResult::Tparent

private

Definition at line 65 of file ESpellResult.hpp.

◆ Tparent [2/5]

typedef NCBI_NS_NCBI::CSerialObject CESpellResult_Base::Tparent

private

Definition at line 76 of file ESpellResult_.hpp.

◆ Tparent [3/5]

typedef CSpelledQuery_Base CSpelledQuery::Tparent

private

Definition at line 65 of file SpelledQuery.hpp.

◆ Tparent [4/5]

typedef NCBI_NS_NCBI::CSerialObject CSpelledQuery_Base::Tparent

private

Definition at line 73 of file SpelledQuery_.hpp.

◆ Tparent [5/5]

typedef NCBI_NS_NCBI::CSerialObject CSpelledQuery_Base::C_Data::Tparent

private

Definition at line 91 of file SpelledQuery_.hpp.

◆ TQuery

typedef NCBI_NS_STD::string CESpellResult_Base::TQuery

Definition at line 88 of file ESpellResult_.hpp.

◆ TReplaced

typedef NCBI_NS_STD::string CSpelledQuery_Base::C_Data::TReplaced

Definition at line 161 of file SpelledQuery_.hpp.

◆ TSpelledQuery

typedef CSpelledQuery CESpellResult_Base::TSpelledQuery

Definition at line 90 of file ESpellResult_.hpp.

Enumeration Type Documentation

◆ E_Choice

enum CSpelledQuery_Base::C_Data::E_Choice

Choice variants.

Enumerator
e_not_set	No variant selected.
e_Replaced	\d+
e_Original	\d+

Definition at line 103 of file SpelledQuery_.hpp.

◆ E_ChoiceStopper

enum CSpelledQuery_Base::C_Data::E_ChoiceStopper

Maximum+1 value of the choice variant enumerator.

Enumerator
e_MaxChoice	== e_Original+1

Definition at line 109 of file SpelledQuery_.hpp.

◆ E_memberIndex

enum CESpellResult_Base::E_memberIndex

strong

Enumerator
e__allMandatory
e_Database
e_Query
e_CorrectedQuery
e_SpelledQuery
e_ERROR

Definition at line 94 of file ESpellResult_.hpp.

Function Documentation

◆ C_Data() [1/2]

CSpelledQuery_Base::C_Data::C_Data ( const C_Data & )

private

◆ C_Data() [2/2]

END_CHOICE_INFO CSpelledQuery_Base::C_Data::C_Data ( void )

Definition at line 123 of file SpelledQuery_.cpp.

◆ CanGet()

bool CSpelledQuery_Base::CanGet ( void ) const

inline

Check if it is safe to call Get method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 377 of file SpelledQuery_.hpp.

◆ CanGetCorrectedQuery()

bool CESpellResult_Base::CanGetCorrectedQuery ( void ) const

inline

Check if it is safe to call GetCorrectedQuery method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 429 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetCorrectedQuery().

Referenced by CESpellResult_Base::GetCorrectedQuery().

◆ CanGetDatabase()

bool CESpellResult_Base::CanGetDatabase ( void ) const

inline

Check if it is safe to call GetDatabase method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 335 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetDatabase().

Referenced by CESpellResult_Base::GetDatabase().

◆ CanGetERROR()

bool CESpellResult_Base::CanGetERROR ( void ) const

inline

Check if it is safe to call GetERROR method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 506 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetERROR().

Referenced by CESpellResult_Base::GetERROR().

◆ CanGetQuery()

bool CESpellResult_Base::CanGetQuery ( void ) const

inline

Check if it is safe to call GetQuery method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 382 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetQuery().

Referenced by CESpellResult_Base::GetQuery().

◆ CanGetSpelledQuery()

bool CESpellResult_Base::CanGetSpelledQuery ( void ) const

inline

Check if it is safe to call GetSpelledQuery method.

Returns

true, if the data member is getatable.
false, otherwise.

Definition at line 476 of file ESpellResult_.hpp.

◆ CESpellResult() [1/2]

CESpellResult::CESpellResult ( const CESpellResult & value )

private

◆ CESpellResult() [2/2]

CESpellResult::CESpellResult ( void )

inline

Definition at line 84 of file ESpellResult.hpp.

◆ CESpellResult_Base() [1/2]

CESpellResult_Base::CESpellResult_Base ( const CESpellResult_Base & )

private

◆ CESpellResult_Base() [2/2]

END_CLASS_INFO CESpellResult_Base::CESpellResult_Base ( void )

Definition at line 111 of file ESpellResult_.cpp.

References CESpellResult_Base::m_set_State, and CESpellResult_Base::ResetSpelledQuery().

◆ CheckSelected()

void CSpelledQuery_Base::C_Data::CheckSelected ( E_Choice index ) const

inline

Verify selection, throw exception if it differs from the expected.

Parameters

index Expected selection.

Definition at line 308 of file SpelledQuery_.hpp.

◆ CSpelledQuery() [1/2]

CSpelledQuery::CSpelledQuery ( const CSpelledQuery & value )

private

◆ CSpelledQuery() [2/2]

CSpelledQuery::CSpelledQuery ( void )

inline

Definition at line 84 of file SpelledQuery.hpp.

◆ CSpelledQuery_Base() [1/2]

CSpelledQuery_Base::CSpelledQuery_Base ( const CSpelledQuery_Base & )

private

◆ CSpelledQuery_Base() [2/2]

END_CLASS_INFO CSpelledQuery_Base::CSpelledQuery_Base ( void )

Definition at line 152 of file SpelledQuery_.cpp.

References CSpelledQuery_Base::m_set_State.

◆ DECLARE_INTERNAL_TYPE_INFO() [1/3]

CESpellResult_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DECLARE_INTERNAL_TYPE_INFO() [2/3]

CSpelledQuery_Base::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DECLARE_INTERNAL_TYPE_INFO() [3/3]

CSpelledQuery_Base::C_Data::DECLARE_INTERNAL_TYPE_INFO ( )

◆ DoSelect()

void CSpelledQuery_Base::C_Data::DoSelect	(	E_Choice	index,
		NCBI_NS_NCBI::CObjectMemoryPool *	pool = `0`
	)

private

Definition at line 67 of file SpelledQuery_.cpp.

◆ Get()

const CSpelledQuery_Base::Tdata & CSpelledQuery_Base::Get ( void ) const

inline

Get the member data.

Returns: Reference to the member data.

Definition at line 383 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::m_data.

◆ GetCorrectedQuery()

const CESpellResult_Base::TCorrectedQuery & CESpellResult_Base::GetCorrectedQuery ( void ) const

inline

Get the CorrectedQuery member data.

Returns: Reference to the member data.

Definition at line 435 of file ESpellResult_.hpp.

References CESpellResult_Base::CanGetCorrectedQuery(), and CESpellResult_Base::m_CorrectedQuery.

◆ GetDatabase()

const CESpellResult_Base::TDatabase & CESpellResult_Base::GetDatabase ( void ) const

inline

Get the Database member data.

Returns: Reference to the member data.

Definition at line 341 of file ESpellResult_.hpp.

References CESpellResult_Base::CanGetDatabase(), and CESpellResult_Base::m_Database.

◆ GetERROR()

const CESpellResult_Base::TERROR & CESpellResult_Base::GetERROR ( void ) const

inline

Get the ERROR member data.

Returns: Reference to the member data.

Definition at line 512 of file ESpellResult_.hpp.

References CESpellResult_Base::CanGetERROR(), and CESpellResult_Base::m_ERROR.

◆ GetOriginal()

const CSpelledQuery_Base::C_Data::TOriginal & CSpelledQuery_Base::C_Data::GetOriginal ( void ) const

inline

Get the variant data.

Returns: Reference to the data.

Definition at line 357 of file SpelledQuery_.hpp.

◆ GetQuery()

const CESpellResult_Base::TQuery & CESpellResult_Base::GetQuery ( void ) const

inline

Get the Query member data.

Returns: Reference to the member data.

Definition at line 388 of file ESpellResult_.hpp.

References CESpellResult_Base::CanGetQuery(), and CESpellResult_Base::m_Query.

◆ GetReplaced()

const CSpelledQuery_Base::C_Data::TReplaced & CSpelledQuery_Base::C_Data::GetReplaced ( void ) const

inline

Get the variant data.

Returns: Reference to the data.

Definition at line 337 of file SpelledQuery_.hpp.

◆ GetSpelledQuery()

const CESpellResult_Base::TSpelledQuery & CESpellResult_Base::GetSpelledQuery ( void ) const

inline

Get the SpelledQuery member data.

Returns: Reference to the member data.

Definition at line 482 of file ESpellResult_.hpp.

References CESpellResult_Base::m_SpelledQuery, and CESpellResult_Base::ResetSpelledQuery().

◆ IsOriginal()

bool CSpelledQuery_Base::C_Data::IsOriginal ( void ) const

inline

Check if variant Original is selected.

Original type is defined as 'typedef NCBI_NS_STD::string TOriginal'.

Returns

true, if the variant is selected.
false, otherwise.

Definition at line 351 of file SpelledQuery_.hpp.

◆ IsReplaced()

bool CSpelledQuery_Base::C_Data::IsReplaced ( void ) const

inline

Check if variant Replaced is selected.

Replaced type is defined as 'typedef NCBI_NS_STD::string TReplaced'.

Returns

true, if the variant is selected.
false, otherwise.

Definition at line 331 of file SpelledQuery_.hpp.

◆ IsSet()

bool CSpelledQuery_Base::IsSet ( void ) const

inline

Check if a value has been assigned to data member.

Data member is mandatory; its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > > Tdata'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 371 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::m_set_State.

◆ IsSetCorrectedQuery()

bool CESpellResult_Base::IsSetCorrectedQuery ( void ) const

inline

\d+ Check if a value has been assigned to CorrectedQuery data member.

Data member CorrectedQuery is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TCorrectedQuery'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 423 of file ESpellResult_.hpp.

References CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::CanGetCorrectedQuery(), and CESpellResult_Base::SetCorrectedQuery().

◆ IsSetDatabase()

bool CESpellResult_Base::IsSetDatabase ( void ) const

inline

\d+ Check if a value has been assigned to Database data member.

Data member Database is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TDatabase'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 329 of file ESpellResult_.hpp.

References CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::CanGetDatabase(), and CESpellResult_Base::SetDatabase().

◆ IsSetERROR()

bool CESpellResult_Base::IsSetERROR ( void ) const

inline

\d+ Check if a value has been assigned to ERROR data member.

Data member ERROR is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TERROR'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 500 of file ESpellResult_.hpp.

References CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::CanGetERROR(), and CESpellResult_Base::SetERROR().

◆ IsSetQuery()

bool CESpellResult_Base::IsSetQuery ( void ) const

inline

\d+ Check if a value has been assigned to Query data member.

Data member Query is mandatory; its type is defined as 'typedef NCBI_NS_STD::string TQuery'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 376 of file ESpellResult_.hpp.

References CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::CanGetQuery(), and CESpellResult_Base::SetQuery().

◆ IsSetSpelledQuery()

bool CESpellResult_Base::IsSetSpelledQuery ( void ) const

inline

\d+ Check if a value has been assigned to SpelledQuery data member.

Data member SpelledQuery is mandatory; its type is defined as 'typedef CSpelledQuery TSpelledQuery'

Returns

true, if a value has been assigned.
false, otherwise.

Definition at line 470 of file ESpellResult_.hpp.

References CESpellResult_Base::m_SpelledQuery.

◆ operator const Tdata &()

CSpelledQuery_Base::operator const CSpelledQuery_Base::Tdata & ( void ) const

inline

Conversion operator to 'const Tdata' type.

Definition at line 396 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::m_data.

◆ operator Tdata &()

CSpelledQuery_Base::operator CSpelledQuery_Base::Tdata & ( void )

inline

Conversion operator to 'Tdata' type.

Definition at line 402 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::m_data, and CSpelledQuery_Base::m_set_State.

◆ operator=() [1/5]

C_Data& CSpelledQuery_Base::C_Data::operator= ( const C_Data & )

private

◆ operator=() [2/5]

CESpellResult& CESpellResult::operator= ( const CESpellResult & value )

private

◆ operator=() [3/5]

CESpellResult_Base& CESpellResult_Base::operator= ( const CESpellResult_Base & )

private

◆ operator=() [4/5]

CSpelledQuery& CSpelledQuery::operator= ( const CSpelledQuery & value )

private

◆ operator=() [5/5]

CSpelledQuery_Base& CSpelledQuery_Base::operator= ( const CSpelledQuery_Base & )

private

◆ Reset() [1/3]

void CESpellResult_Base::Reset ( void )

virtual

Reset the whole object.

Definition at line 87 of file ESpellResult_.cpp.

References CESpellResult_Base::ResetCorrectedQuery(), CESpellResult_Base::ResetDatabase(), CESpellResult_Base::ResetERROR(), CESpellResult_Base::ResetQuery(), and CESpellResult_Base::ResetSpelledQuery().

◆ Reset() [2/3]

BEGIN_espell_SCOPE void CSpelledQuery_Base::C_Data::Reset ( void )

Reset the whole object.

Definition at line 48 of file SpelledQuery_.cpp.

References CSpelledQuery_Base::C_Data::e_not_set, CSpelledQuery_Base::C_Data::m_choice, and CSpelledQuery_Base::C_Data::ResetSelection().

◆ Reset() [3/3]

void CSpelledQuery_Base::Reset ( void )

Reset data member.

Definition at line 135 of file SpelledQuery_.cpp.

References CSpelledQuery_Base::m_data, and CSpelledQuery_Base::m_set_State.

Referenced by CSpelledQuery_Base::C_Data::~C_Data().

◆ ResetCorrectedQuery()

void CESpellResult_Base::ResetCorrectedQuery ( void )

Reset CorrectedQuery data member.

Definition at line 61 of file ESpellResult_.cpp.

References CESpellResult_Base::m_CorrectedQuery, and CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::Reset().

◆ ResetDatabase()

BEGIN_espell_SCOPE void CESpellResult_Base::ResetDatabase ( void )

Reset Database data member.

Definition at line 49 of file ESpellResult_.cpp.

References CESpellResult_Base::m_Database, and CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::Reset().

◆ ResetERROR()

void CESpellResult_Base::ResetERROR ( void )

Reset ERROR data member.

Definition at line 81 of file ESpellResult_.cpp.

References CESpellResult_Base::m_ERROR, and CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::Reset().

◆ ResetQuery()

void CESpellResult_Base::ResetQuery ( void )

Reset Query data member.

Definition at line 55 of file ESpellResult_.cpp.

References CESpellResult_Base::m_Query, and CESpellResult_Base::m_set_State.

Referenced by CESpellResult_Base::Reset().

◆ ResetSelection()

void CSpelledQuery_Base::C_Data::ResetSelection ( void )

Reset the selection (set it to e_not_set).

Definition at line 54 of file SpelledQuery_.cpp.

References e_not_set.

Referenced by CSpelledQuery_Base::C_Data::Reset().

◆ ResetSpelledQuery()

void CESpellResult_Base::ResetSpelledQuery ( void )

Reset SpelledQuery data member.

Definition at line 67 of file ESpellResult_.cpp.

References CESpellResult_Base::m_SpelledQuery.

Referenced by CESpellResult_Base::CESpellResult_Base(), CESpellResult_Base::GetSpelledQuery(), CESpellResult_Base::Reset(), and CESpellResult_Base::SetSpelledQuery().

◆ Select() [1/2]

void CSpelledQuery_Base::C_Data::Select	(	E_Choice	index,
		NCBI_NS_NCBI::EResetVariant	reset,
		NCBI_NS_NCBI::CObjectMemoryPool *	pool
	)

inline

Select the requested variant if needed, allocating CObject variants from memory pool.

Definition at line 315 of file SpelledQuery_.hpp.

References e_not_set, and eDoResetVariant.

◆ Select() [2/2]

void CSpelledQuery_Base::C_Data::Select	(	E_Choice	index,
		NCBI_NS_NCBI::EResetVariant	reset = `NCBI_NS_NCBI::eDoResetVariant`
	)

inline

Select the requested variant if needed.

Parameters

index	New selection state.
reset	Flag that defines the resetting of the variant data. The data will be reset if either the current selection differs from the new one, or the flag is set to eDoResetVariant.

Definition at line 325 of file SpelledQuery_.hpp.

◆ SelectionName()

NCBI_NS_STD::string CSpelledQuery_Base::C_Data::SelectionName ( E_Choice index )

static

Retrieve selection name (for diagnostic purposes).

Parameters

index One of possible selection states.

Returns: Name string.

Definition at line 86 of file SpelledQuery_.cpp.

◆ Set()

CSpelledQuery_Base::Tdata & CSpelledQuery_Base::Set ( void )

inline

Assign a value to data member.

Returns: Reference to the data value.

Definition at line 389 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::m_data, and CSpelledQuery_Base::m_set_State.

◆ SetCorrectedQuery() [1/3]

void CESpellResult_Base::SetCorrectedQuery ( const TCorrectedQuery & value )

inline

Assign a value to CorrectedQuery data member.

Parameters

value Value to assign

Definition at line 444 of file ESpellResult_.hpp.

References CESpellResult_Base::m_CorrectedQuery, CESpellResult_Base::m_set_State, and value.

◆ SetCorrectedQuery() [2/3]

void CESpellResult_Base::SetCorrectedQuery ( CESpellResult_Base::TCorrectedQuery && value )

inline

Definition at line 451 of file ESpellResult_.hpp.

References CESpellResult_Base::m_CorrectedQuery, CESpellResult_Base::m_set_State, and value.

◆ SetCorrectedQuery() [3/3]

CESpellResult_Base::TCorrectedQuery & CESpellResult_Base::SetCorrectedQuery ( void )

inline

Assign a value to CorrectedQuery data member.

Returns: Reference to the data value.

Definition at line 458 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetCorrectedQuery(), CESpellResult_Base::m_CorrectedQuery, and CESpellResult_Base::m_set_State.

◆ SetDatabase() [1/3]

void CESpellResult_Base::SetDatabase ( const TDatabase & value )

inline

Assign a value to Database data member.

Parameters

value Value to assign

Definition at line 350 of file ESpellResult_.hpp.

References CESpellResult_Base::m_Database, CESpellResult_Base::m_set_State, and value.

◆ SetDatabase() [2/3]

void CESpellResult_Base::SetDatabase ( CESpellResult_Base::TDatabase && value )

inline

Definition at line 357 of file ESpellResult_.hpp.

References CESpellResult_Base::m_Database, CESpellResult_Base::m_set_State, and value.

◆ SetDatabase() [3/3]

CESpellResult_Base::TDatabase & CESpellResult_Base::SetDatabase ( void )

inline

Assign a value to Database data member.

Returns: Reference to the data value.

Definition at line 364 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetDatabase(), CESpellResult_Base::m_Database, and CESpellResult_Base::m_set_State.

◆ SetERROR() [1/3]

void CESpellResult_Base::SetERROR ( const TERROR & value )

inline

Assign a value to ERROR data member.

Parameters

value Value to assign

Definition at line 521 of file ESpellResult_.hpp.

References CESpellResult_Base::m_ERROR, CESpellResult_Base::m_set_State, and value.

◆ SetERROR() [2/3]

void CESpellResult_Base::SetERROR ( CESpellResult_Base::TERROR && value )

inline

Definition at line 528 of file ESpellResult_.hpp.

References CESpellResult_Base::m_ERROR, CESpellResult_Base::m_set_State, and value.

◆ SetERROR() [3/3]

CESpellResult_Base::TERROR & CESpellResult_Base::SetERROR ( void )

inline

Assign a value to ERROR data member.

Returns: Reference to the data value.

Definition at line 535 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetERROR(), CESpellResult_Base::m_ERROR, and CESpellResult_Base::m_set_State.

◆ SetOriginal() [1/2]

void CSpelledQuery_Base::C_Data::SetOriginal ( const TOriginal & value )

Select the variant and set its data.

Parameters

value Variant data.

Definition at line 102 of file SpelledQuery_.cpp.

References eDoNotResetVariant, and value.

◆ SetOriginal() [2/2]

CSpelledQuery_Base::C_Data::TOriginal & CSpelledQuery_Base::C_Data::SetOriginal ( void )

inline

Select the variant.

Returns: Reference to the variant data.

Definition at line 364 of file SpelledQuery_.hpp.

References eDoNotResetVariant.

◆ SetQuery() [1/3]

void CESpellResult_Base::SetQuery ( const TQuery & value )

inline

Assign a value to Query data member.

Parameters

value Value to assign

Definition at line 397 of file ESpellResult_.hpp.

References CESpellResult_Base::m_Query, CESpellResult_Base::m_set_State, and value.

◆ SetQuery() [2/3]

void CESpellResult_Base::SetQuery ( CESpellResult_Base::TQuery && value )

inline

Definition at line 404 of file ESpellResult_.hpp.

References CESpellResult_Base::m_Query, CESpellResult_Base::m_set_State, and value.

◆ SetQuery() [3/3]

CESpellResult_Base::TQuery & CESpellResult_Base::SetQuery ( void )

inline

Assign a value to Query data member.

Returns: Reference to the data value.

Definition at line 411 of file ESpellResult_.hpp.

References CESpellResult_Base::IsSetQuery(), CESpellResult_Base::m_Query, and CESpellResult_Base::m_set_State.

◆ SetReplaced() [1/2]

void CSpelledQuery_Base::C_Data::SetReplaced ( const TReplaced & value )

Select the variant and set its data.

Parameters

value Variant data.

Definition at line 96 of file SpelledQuery_.cpp.

References eDoNotResetVariant, and value.

◆ SetReplaced() [2/2]

CSpelledQuery_Base::C_Data::TReplaced & CSpelledQuery_Base::C_Data::SetReplaced ( void )

inline

Select the variant.

Returns: Reference to the variant data.

Definition at line 344 of file SpelledQuery_.hpp.

References eDoNotResetVariant.

◆ SetSpelledQuery() [1/2]

void CESpellResult_Base::SetSpelledQuery ( CESpellResult_Base::TSpelledQuery & value )

Assign a value to SpelledQuery data member.

Parameters

value Reference to value.

Definition at line 76 of file ESpellResult_.cpp.

References CESpellResult_Base::m_SpelledQuery, and value.

◆ SetSpelledQuery() [2/2]

CESpellResult_Base::TSpelledQuery & CESpellResult_Base::SetSpelledQuery ( void )

inline

Assign a value to SpelledQuery data member.

Returns: Reference to the data value.

Definition at line 491 of file ESpellResult_.hpp.

References CESpellResult_Base::m_SpelledQuery, and CESpellResult_Base::ResetSpelledQuery().

◆ ThrowInvalidSelection()

void CSpelledQuery_Base::C_Data::ThrowInvalidSelection ( E_Choice index ) const

Throw 'InvalidSelection' exception.

Parameters

index Expected selection.

Definition at line 91 of file SpelledQuery_.cpp.

References DIAG_COMPILE_INFO.

◆ Which()

CSpelledQuery_Base::C_Data::E_Choice CSpelledQuery_Base::C_Data::Which ( void ) const

inline

Which variant is currently selected.

Returns: Choice state enumerator.

Definition at line 302 of file SpelledQuery_.hpp.

References CSpelledQuery_Base::C_Data::m_choice.

◆ ~C_Data()

CSpelledQuery_Base::C_Data::~C_Data ( void )

Definition at line 129 of file SpelledQuery_.cpp.

References CSpelledQuery_Base::Reset().

◆ ~CESpellResult()

BEGIN_espell_SCOPE CESpellResult::~CESpellResult ( void )

Definition at line 48 of file ESpellResult.cpp.

◆ ~CESpellResult_Base()

CESpellResult_Base::~CESpellResult_Base ( void )

virtual

Definition at line 120 of file ESpellResult_.cpp.

◆ ~CSpelledQuery()

BEGIN_espell_SCOPE CSpelledQuery::~CSpelledQuery ( void )

Definition at line 48 of file SpelledQuery.cpp.

◆ ~CSpelledQuery_Base()

CSpelledQuery_Base::~CSpelledQuery_Base ( void )

virtual

Definition at line 158 of file SpelledQuery_.cpp.

Variable Documentation

◆

union { ... }

◆ m_choice

E_Choice CSpelledQuery_Base::C_Data::m_choice

private

Definition at line 227 of file SpelledQuery_.hpp.

Referenced by CSpelledQuery_Base::C_Data::Reset(), and CSpelledQuery_Base::C_Data::Which().

◆ m_CorrectedQuery

NCBI_NS_STD::string CESpellResult_Base::m_CorrectedQuery

private

Definition at line 314 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::GetCorrectedQuery(), CESpellResult_Base::ResetCorrectedQuery(), and CESpellResult_Base::SetCorrectedQuery().

◆ m_data

NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_Data > > CSpelledQuery_Base::m_data

private

Definition at line 289 of file SpelledQuery_.hpp.

Referenced by BEGIN_NAMED_BASE_IMPLICIT_CLASS_INFO(), CSpelledQuery_Base::Get(), CSpelledQuery_Base::operator const Tdata &(), CSpelledQuery_Base::operator Tdata &(), CSpelledQuery_Base::Reset(), and CSpelledQuery_Base::Set().

◆ m_Database

NCBI_NS_STD::string CESpellResult_Base::m_Database

private

Definition at line 312 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::GetDatabase(), CESpellResult_Base::ResetDatabase(), and CESpellResult_Base::SetDatabase().

◆ m_dummy_pointer_for_alignment [1/2]

void* CSpelledQuery_Base::C_Data::m_dummy_pointer_for_alignment

Definition at line 235 of file SpelledQuery_.hpp.

◆ [2/2]

void* { ... } ::m_dummy_pointer_for_alignment

Definition at line 235 of file SpelledQuery_.hpp.

◆ m_ERROR

NCBI_NS_STD::string CESpellResult_Base::m_ERROR

private

Definition at line 316 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::GetERROR(), CESpellResult_Base::ResetERROR(), and CESpellResult_Base::SetERROR().

◆ m_Query

NCBI_NS_STD::string CESpellResult_Base::m_Query

private

Definition at line 313 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::GetQuery(), CESpellResult_Base::ResetQuery(), and CESpellResult_Base::SetQuery().

◆ m_set_State [1/2]

Uint4 CESpellResult_Base::m_set_State[1]

private

Definition at line 311 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::CESpellResult_Base(), CESpellResult_Base::IsSetCorrectedQuery(), CESpellResult_Base::IsSetDatabase(), CESpellResult_Base::IsSetERROR(), CESpellResult_Base::IsSetQuery(), CESpellResult_Base::ResetCorrectedQuery(), CESpellResult_Base::ResetDatabase(), CESpellResult_Base::ResetERROR(), CESpellResult_Base::ResetQuery(), CESpellResult_Base::SetCorrectedQuery(), CESpellResult_Base::SetDatabase(), CESpellResult_Base::SetERROR(), and CESpellResult_Base::SetQuery().

◆ m_set_State [2/2]

Uint4 CSpelledQuery_Base::m_set_State[1]

private

Definition at line 288 of file SpelledQuery_.hpp.

Referenced by BEGIN_NAMED_BASE_IMPLICIT_CLASS_INFO(), CSpelledQuery_Base::CSpelledQuery_Base(), CSpelledQuery_Base::IsSet(), CSpelledQuery_Base::operator Tdata &(), CSpelledQuery_Base::Reset(), and CSpelledQuery_Base::Set().

◆ m_SpelledQuery

NCBI_NS_NCBI::CRef< TSpelledQuery > CESpellResult_Base::m_SpelledQuery

private

Definition at line 315 of file ESpellResult_.hpp.

Referenced by CESpellResult_Base::GetSpelledQuery(), CESpellResult_Base::IsSetSpelledQuery(), CESpellResult_Base::ResetSpelledQuery(), and CESpellResult_Base::SetSpelledQuery().

◆ m_string [1/2]

NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> CSpelledQuery_Base::C_Data::m_string

Definition at line 234 of file SpelledQuery_.hpp.

◆ [2/2]

NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> { ... } ::m_string

Definition at line 234 of file SpelledQuery_.hpp.

◆ sm_SelectionNames

const char *const CSpelledQuery_Base::C_Data::sm_SelectionNames

staticprivate

Initial value:

= {
    "not set",
    "Replaced",
    "Original"
}

Definition at line 231 of file SpelledQuery_.hpp.

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ TCorrectedQuery

◆ Tdata

◆ TDatabase

◆ TERROR

◆ TmemberIndex

◆ TOriginal

◆ Tparent [1/5]

◆ Tparent [2/5]

◆ Tparent [3/5]

◆ Tparent [4/5]

◆ Tparent [5/5]

◆ TQuery

◆ TReplaced

◆ TSpelledQuery

Enumeration Type Documentation

◆ E_Choice

◆ E_ChoiceStopper

◆ E_memberIndex

Function Documentation

◆ C_Data() [1/2]

◆ C_Data() [2/2]

◆ CanGet()

◆ CanGetCorrectedQuery()

◆ CanGetDatabase()

◆ CanGetERROR()

◆ CanGetQuery()

◆ CanGetSpelledQuery()

◆ CESpellResult() [1/2]

◆ CESpellResult() [2/2]

◆ CESpellResult_Base() [1/2]

◆ CESpellResult_Base() [2/2]

◆ CheckSelected()

◆ CSpelledQuery() [1/2]

◆ CSpelledQuery() [2/2]

◆ CSpelledQuery_Base() [1/2]

◆ CSpelledQuery_Base() [2/2]

◆ DECLARE_INTERNAL_TYPE_INFO() [1/3]

◆ DECLARE_INTERNAL_TYPE_INFO() [2/3]

◆ DECLARE_INTERNAL_TYPE_INFO() [3/3]

◆ DoSelect()

◆ Get()

◆ GetCorrectedQuery()

◆ GetDatabase()

◆ GetERROR()

◆ GetOriginal()

◆ GetQuery()

◆ GetReplaced()

◆ GetSpelledQuery()

◆ IsOriginal()

◆ IsReplaced()

◆ IsSet()

◆ IsSetCorrectedQuery()

◆ IsSetDatabase()

◆ IsSetERROR()

◆ IsSetQuery()

◆ IsSetSpelledQuery()

◆ operator const Tdata &()

◆ operator Tdata &()

◆ operator=() [1/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ Reset() [1/3]

◆ Reset() [2/3]

◆ Reset() [3/3]

◆ ResetCorrectedQuery()

◆ ResetDatabase()

◆ ResetERROR()

◆ ResetQuery()

◆ ResetSelection()

◆ ResetSpelledQuery()

◆ Select() [1/2]