ttsdk::AlgoDefinition Class Reference

#include <algo_definition.h>

Inheritance diagram for ttsdk::AlgoDefinition:

Collaboration diagram for ttsdk::AlgoDefinition:

Public Types
enum class	ResponseCode {   SUCCESS = 0 , FAILED = 1 , INVALID_REQUEST = 2 , NOT_ALLOWED = 3 ,   THROTTLE_EXCEEDED = 4 , NOT_FOUND = 5 }

Public Member Functions
virtual uint64_t	GetAlgoDefinitionId () const noexcept=0
virtual const char *	GetName () const noexcept=0
virtual AlgoType	GetAlgoType () const noexcept=0
virtual const char *	GetOpaqueData () const noexcept=0
virtual const char *	GetAlgoVersion () const noexcept=0
virtual uint32_t	GetParameterCount () const noexcept=0
virtual ttsdk::UserParamDefinitionPtr	GetParameterDefinition (const uint32_t index) const noexcept=0
virtual uint32_t	GetExportValueCount () const noexcept=0
virtual ttsdk::ExportValueDefinitionPtr	GetExportValueDefinition (const uint32_t index) const noexcept=0
	AlgoDefinition ()
	~AlgoDefinition ()
Public Member Functions inherited from ttsdk::shared_base
	shared_base ()
virtual	~shared_base ()
int	dec_ref () const
void	inc_ref () const
virtual void	del_ref () const

Detailed Description

Definition at line 65 of file algo_definition.h.

Member Enumeration Documentation

ResponseCode

enum class ttsdk::AlgoDefinition::ResponseCode

strong

Enumerator
SUCCESS
FAILED
INVALID_REQUEST
NOT_ALLOWED
THROTTLE_EXCEEDED
NOT_FOUND

Definition at line 68 of file algo_definition.h.

Constructor & Destructor Documentation

AlgoDefinition()

ttsdk::AlgoDefinition::AlgoDefinition ( )

inlineexplicit

Definition at line 91 of file algo_definition.h.

~AlgoDefinition()

ttsdk::AlgoDefinition::~AlgoDefinition ( )

inline

Definition at line 92 of file algo_definition.h.

Member Function Documentation

GetAlgoDefinitionId()

virtual uint64_t ttsdk::AlgoDefinition::GetAlgoDefinitionId ( ) const

pure virtualnoexcept

GetAlgoType()

virtual AlgoType ttsdk::AlgoDefinition::GetAlgoType ( ) const

pure virtualnoexcept

GetAlgoVersion()

virtual const char * ttsdk::AlgoDefinition::GetAlgoVersion ( ) const

pure virtualnoexcept

GetExportValueCount()

virtual uint32_t ttsdk::AlgoDefinition::GetExportValueCount ( ) const

pure virtualnoexcept

GetExportValueDefinition()

virtual ttsdk::ExportValueDefinitionPtr ttsdk::AlgoDefinition::GetExportValueDefinition ( const uint32_t index ) const

pure virtualnoexcept

GetName()

virtual const char * ttsdk::AlgoDefinition::GetName ( ) const

pure virtualnoexcept

GetOpaqueData()

virtual const char * ttsdk::AlgoDefinition::GetOpaqueData ( ) const

pure virtualnoexcept

GetParameterCount()

virtual uint32_t ttsdk::AlgoDefinition::GetParameterCount ( ) const

pure virtualnoexcept

GetParameterDefinition()

virtual ttsdk::UserParamDefinitionPtr ttsdk::AlgoDefinition::GetParameterDefinition ( const uint32_t index ) const

pure virtualnoexcept

---

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

• algo_definition.h