Public Types | Public Member Functions
InferenceEngine::IMemoryState Class Referenceabstract

manages data for reset operations More...

#include <ie_imemory_state.hpp>

Inheritance diagram for InferenceEngine::IMemoryState:
Inheritance graph
[legend]
Collaboration diagram for InferenceEngine::IMemoryState:
Collaboration graph
[legend]

Public Types

using  Ptr = std::shared_ptr< IMemoryState >
 

Public Member Functions

virtual StatusCode  GetName (char *name, size_t len, ResponseDesc *resp) const noexcept=0
  Gets name of current memory state, if length of array is not enough name is truncated by len, null terminator is inserted as well. More...
 
virtual StatusCode  Reset (ResponseDesc *resp) noexcept=0
  reset internal memory state for relevant iexecutable network, to a value specified in SetState More...
 
virtual StatusCode  SetState (Blob::Ptr newState, ResponseDesc *resp) noexcept=0
  Sets the new state that is used for all future Reset() operations as a base. This method can fail if Blob size does not match the internal state size or precision. More...
 
virtual StatusCode  GetLastState (Blob::CPtr &lastState, ResponseDesc *resp) const noexcept=0
  returns the value of the last memory state. More...
 

Detailed Description

manages data for reset operations

Member Function Documentation

§ GetLastState()

virtual StatusCode InferenceEngine::IMemoryState::GetLastState ( Blob::CPtr &  lastState,
ResponseDesc *  resp 
) const
pure virtualnoexcept

returns the value of the last memory state.

Since we roll memory after each infer, we can query the input state always and still get the last state.

Parameters
lastState
resp Optional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: OK (0) for success

§ GetName()

virtual StatusCode InferenceEngine::IMemoryState::GetName ( char *  name,
size_t  len,
ResponseDesc *  resp 
) const
pure virtualnoexcept

Gets name of current memory state, if length of array is not enough name is truncated by len, null terminator is inserted as well.

Parameters
name preallocated buffer for receiving name
len Length of the buffer
resp Optional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: OK (0) for success

§ Reset()

virtual StatusCode InferenceEngine::IMemoryState::Reset ( ResponseDesc *  resp )
pure virtualnoexcept

reset internal memory state for relevant iexecutable network, to a value specified in SetState

Parameters
resp Optional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: OK (0) for success*

§ SetState()

virtual StatusCode InferenceEngine::IMemoryState::SetState ( Blob::Ptr  newState,
ResponseDesc *  resp 
)
pure virtualnoexcept

Sets the new state that is used for all future Reset() operations as a base. This method can fail if Blob size does not match the internal state size or precision.

Parameters
newState is the data to use as base state
resp Optional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: OK (0) for success
The documentation for this class was generated from the following file: