alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle Struct Reference

Description:

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>
struct alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle

A handle type used with methods Export and ImportCursor.

Definition at line 647 of file stringtree.inl.

Public Field Index:
uinteger	value
	The encapsulated value.

Public Method Index:
	ConstCursorHandle ()=default
	Defaulted default constructor.
	ConstCursorHandle (const CursorHandle &mutableHandle)
	ConstCursorHandle (uinteger pValue)
bool	IsValid () const noexcept
bool	operator== (const ConstCursorHandle &other) const noexcept
bool	operator== (const CursorHandle &other) const noexcept

Field Details:

value

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

uinteger alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::value

The encapsulated value.

Definition at line 649 of file stringtree.inl.

Constructor(s) / Destructor Details:

ConstCursorHandle() [1/2]

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::ConstCursorHandle ( uinteger pValue )

inline

Constructor accepting a raw value.

Parameters

pValue

The value that this handle is supposed to use.

Definition at line 656 of file stringtree.inl.

ConstCursorHandle() [2/2]

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::ConstCursorHandle ( const CursorHandle & mutableHandle )

inline

Constructor accepting a mutable handle.

Parameters

mutableHandle

The mutable handle that is to be converted to a constant one.

Definition at line 660 of file stringtree.inl.

Method Details:

IsValid()

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

bool alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::IsValid ( ) const

inlinenoexcept

Checks if this is a valid handle.

Returns

true if this handle is not nulled.

Definition at line 677 of file stringtree.inl.

operator==() [1/2]

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

bool alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::operator== ( const ConstCursorHandle & other ) const

inlinenoexcept

Comparison operator.

Parameters

other

The cursor handle to compare this handle to.

Returns

true if both handles refer to the same cursor or if both handles are invalid. false otherwise.

Definition at line 666 of file stringtree.inl.

operator==() [2/2]

template<typename TAllocator, typename T, typename TNodeHandler = StringTreeNamesDynamic<character>, Recycling TRecycling = Recycling::Private>

bool alib::containers::StringTree< TAllocator, T, TNodeHandler, TRecycling >::ConstCursorHandle::operator== ( const CursorHandle & other ) const

inlinenoexcept

Comparison operator.

Parameters

other

The cursor handle to compare this handle to.

Returns

true if both handles refer to the same cursor or if both handles are invalid. false otherwise.

Definition at line 673 of file stringtree.inl.

---

The documentation for this struct was generated from the following file:

• stringtree.inl