myscript::iink::RecognitionAssetsBuilder Class Reference

#include <RecognitionAssetsBuilder.h>

Public Member Functions
virtual	~RecognitionAssetsBuilder ()=default
virtual std::vector< String >	getSupportedRecognitionAssetsTypes ()=0
virtual String	getSupportedSymbols (const String &resourcePath)=0
virtual void	compile (const String &type, const String &data)=0
virtual String	getCompilationErrors () const =0
virtual void	store (const String &fileName) const =0

Detailed Description

The RecognitionAssetsBuilder implements the tools to generate and save recognition assets.

Since

1.2.4

Constructor & Destructor Documentation

~RecognitionAssetsBuilder()

virtual myscript::iink::RecognitionAssetsBuilder::~RecognitionAssetsBuilder ( )

virtualdefault

Member Function Documentation

getSupportedRecognitionAssetsTypes()

virtual std::vector< String > myscript::iink::RecognitionAssetsBuilder::getSupportedRecognitionAssetsTypes ( )

pure virtual

Returns the types of assets that can be generated by this recognition assets builder.

Returns

an array of the supported types.

getSupportedSymbols()

virtual String myscript::iink::RecognitionAssetsBuilder::getSupportedSymbols ( const String &  resourcePath )

pure virtual

Get the list of symbols supported by a resource.

Parameters

resourcePath

the path of the resource.

Returns

the list of supported symbols.

Exceptions

std::runtime_error

when the symbols could not be loaded from the resource.

Since

3.0

compile()

virtual void myscript::iink::RecognitionAssetsBuilder::compile ( const String &  type, const String &  data  )

pure virtual

Compiles data into a recognition asset.

Parameters

type	the type of asset that will be generated.
data	the data to compile.

Exceptions

std::invalid_argument	when type is not supported.
std::runtime_error	when the content of data could not be compiled into a recognition asset.

getCompilationErrors()

virtual String myscript::iink::RecognitionAssetsBuilder::getCompilationErrors ( ) const

pure virtual

Get the last compilation errors.

Returns

a description of the errors that occurred during the last compilation.

store()

virtual void myscript::iink::RecognitionAssetsBuilder::store ( const String &  fileName ) const

pure virtual

Saves the previously compiled recognition asset.

Parameters

fileName

the destination file.

Exceptions

std::runtime_error	when there is no valid recognition asset to store.
std::runtime_error	when an I/O operation fails.

---

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

• iink/RecognitionAssetsBuilder.h