AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Classes | Public Types | Public Member Functions | Friends | List of all members
alexaClientSDK::avsCommon::utils::TypeIndex Struct Reference

#include <TypeIndex.h>

Classes

struct  TypeSpecific
 

Public Types

using Value = void *
 

Public Member Functions

std::string getName () const
 
bool operator== (TypeIndex rhs) const
 
bool operator!= (TypeIndex rhs) const
 
bool operator< (TypeIndex rhs) const
 

Friends

template<typename Type >
TypeIndex getTypeIndex ()
 

Detailed Description

TypeIndex provide a sortable and hashable identity for C++ types, much like std::type_index, but with optional use of RTTI.

Member Typedef Documentation

◆ Value

Type of value used to identify discrete types. Without RTTI enabled this will point to a static member of the TypeSpecific<Type> class.

Member Function Documentation

◆ getName()

std::string alexaClientSDK::avsCommon::utils::TypeIndex::getName ( ) const
inline

A string that uniquely identifies the type.

Returns
A string that uniquely identifies the type.

◆ operator!=()

bool alexaClientSDK::avsCommon::utils::TypeIndex::operator!= ( TypeIndex  rhs) const
inline

Non-Equality operator.

Parameters
rhsThe right hand side of the comparison.
Returns
Whether the two TypeIndex instances do NOT refer to the same type.

◆ operator<()

bool alexaClientSDK::avsCommon::utils::TypeIndex::operator< ( TypeIndex  rhs) const
inline

Comparison operator.

Parameters
rhsThe right hand side of the comparison.
Returns
Whether this instance should sort as less than the rhs instance.

◆ operator==()

bool alexaClientSDK::avsCommon::utils::TypeIndex::operator== ( TypeIndex  rhs) const
inline

Equality operator.

Parameters
rhsThe right hand side of the comparison.
Returns
Whether the two TypeIndex instances refer to the same type.

Friends And Related Function Documentation

◆ getTypeIndex

template<typename Type >
TypeIndex getTypeIndex ( )
friend

Get the TypeIndex value for Type.

Template Parameters
TypeThe type for which to create a TypeIndex value.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0