File UserBufferMap.h

↰ Parent directory (DlSystem)

Definition (DlSystem/UserBufferMap.h)

Includes

• DlSystem/DlError.h (File DlError.h)

• DlSystem/IUserBuffer.h (File IUserBuffer.h)

• DlSystem/SnpeApiExportDefine.h (File SnpeApiExportDefine.h)

• DlSystem/StringList.h (File StringList.h)

Included By

• File SNPE.h

• File UserBufferList.h

Functions

• Function Snpe_UserBufferMap_Add

• Function Snpe_UserBufferMap_Assign

• Function Snpe_UserBufferMap_Clear

• Function Snpe_UserBufferMap_Create

• Function Snpe_UserBufferMap_CreateCopy

• Function Snpe_UserBufferMap_Delete

• Function Snpe_UserBufferMap_GetUserBuffer_Ref

• Function Snpe_UserBufferMap_GetUserBufferNames

• Function Snpe_UserBufferMap_Remove

• Function Snpe_UserBufferMap_Size

Typedefs

• Typedef Snpe_UserBufferMap_Handle_t

Full File Listing

Typedefs

typedef void *Snpe_UserBufferMap_Handle_t

A typedef to indicate a SNPE UserBufferMap handle

Functions

Snpe_UserBufferMap_Handle_t Snpe_UserBufferMap_Create()

Creates a new empty UserBuffer map

Snpe_UserBufferMap_Handle_t Snpe_UserBufferMap_CreateCopy(Snpe_UserBufferMap_Handle_t other)

copy constructor.

Parameters

other – [in] : Handle to the other userBufferMap to be copied from.

Snpe_ErrorCode_t Snpe_UserBufferMap_Add(Snpe_UserBufferMap_Handle_t handle, const char *name, Snpe_IUserBuffer_Handle_t bufferHandle)

Adds a name and the corresponding UserBuffer pointer to the map.

Parameters

• handle – [in] : Handle to access UserBufferMap

• name – [in] : The name of the UserBuffer

• bufferHandle – [in] : Handle to access UserBuffer

Note

If a UserBuffer with the same name already exists, the new UserBuffer pointer would be updated.

Snpe_ErrorCode_t Snpe_UserBufferMap_Remove(Snpe_UserBufferMap_Handle_t handle, const char *name)

Removes a mapping of one UserBuffer and its name by its name.

Parameters

• handle – [in] : Handle to access UserBufferMap

• name – [in] : The name of UserBuffer to be removed

Note

If no UserBuffer with the specified name is found, nothing is done.

size_t Snpe_UserBufferMap_Size(Snpe_UserBufferMap_Handle_t handle)

Returns the number of UserBuffers in the map.

Parameters

handle – [in] : Handle to access UserBufferMap

Snpe_ErrorCode_t Snpe_UserBufferMap_Clear(Snpe_UserBufferMap_Handle_t handle)

Parameters

handle – [in] : Handle to access UserBufferMap Removes all UserBuffers from the map

Snpe_IUserBuffer_Handle_t Snpe_UserBufferMap_GetUserBuffer_Ref(Snpe_UserBufferMap_Handle_t handle, const char *name)

Returns the UserBuffer given its name.

Parameters

• handle – [in] : Handle to access UserBufferMap

• name – [in] : The name of the UserBuffer to get.

Returns

nullptr if no UserBuffer with the specified name is found; otherwise, a valid pointer to the UserBuffer.

Snpe_StringList_Handle_t Snpe_UserBufferMap_GetUserBufferNames(Snpe_UserBufferMap_Handle_t handle)

Returns the names of all UserBuffers

Parameters

handle – [in] : Handle to access UserBufferMap

Returns

A list of UserBuffer names.

Snpe_ErrorCode_t Snpe_UserBufferMap_Assign(Snpe_UserBufferMap_Handle_t srcHandle, Snpe_UserBufferMap_Handle_t dstHandle)

Copy-assigns the contents of srcHandle into dstHandle

Parameters

• src – Source UserBufferMap handle

• dst – Destination UserBufferMap handle

Returns

SNPE_SUCCESS on successful copy-assignment

Snpe_ErrorCode_t Snpe_UserBufferMap_Delete(Snpe_UserBufferMap_Handle_t handle)

Destroys/frees UserBuffer Map

Parameters

handle – [in] : Handle to access UserBuffer Map

Returns

SNPE_SUCCESS if Delete operation successful.