Public Types | Public Member Functions
InferenceEngine::IVariableState Interface Referenceabstract

Manages data for reset operations. More...

#include <ie_imemory_state.hpp>

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

Public Types

using Ptr = std::shared_ptr< IVariableState >
 A shared pointer to the IVariableState interface.
 

Public Member Functions

virtual StatusCode GetName (char *name, size_t len, ResponseDesc *resp) const noexcept=0
 Gets name of current variable state, if length of array is not enough name is truncated by len, null terminator is inserted as well. As variable state name variable_id from according ReadValue used. More...
 
virtual StatusCode Reset (ResponseDesc *resp) noexcept=0
 Reset internal variable state for relevant infer request, to a value specified as default for according ReadValue node. More...
 
virtual StatusCode SetState (Blob::Ptr newState, ResponseDesc *resp) noexcept=0
 Sets the new state for the next inference. More...
 
virtual StatusCode GetLastState (Blob::CPtr &state, ResponseDesc *resp) const noexcept
 Returns the value of the variable state. More...
 
virtual StatusCode GetState (Blob::CPtr &state, ResponseDesc *resp) const noexcept=0
 Returns the value of the variable state. More...
 

Detailed Description

Manages data for reset operations.

Member Function Documentation

◆ GetLastState()

virtual StatusCode InferenceEngine::IVariableState::GetLastState ( Blob::CPtr state,
ResponseDesc resp 
) const
inlinevirtualnoexcept

Returns the value of the variable state.

Parameters
stateA reference to a blob containing a variable state
respOptional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: InferenceEngine::OK (0) for success

◆ GetName()

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

Gets name of current variable state, if length of array is not enough name is truncated by len, null terminator is inserted as well. As variable state name variable_id from according ReadValue used.

Parameters
namepreallocated buffer for receiving name
lenLength of the buffer
respOptional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: InferenceEngine::OK (0) for success

◆ GetState()

virtual StatusCode InferenceEngine::IVariableState::GetState ( Blob::CPtr state,
ResponseDesc resp 
) const
pure virtualnoexcept

Returns the value of the variable state.

Parameters
stateA reference to a blob containing a variable state
respOptional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: InferenceEngine::OK (0) for success

◆ Reset()

virtual StatusCode InferenceEngine::IVariableState::Reset ( ResponseDesc resp)
pure virtualnoexcept

Reset internal variable state for relevant infer request, to a value specified as default for according ReadValue node.

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

◆ SetState()

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

Sets the new state for the next inference.

This method can fail if Blob size does not match the internal state size or precision

Parameters
newStateThe data to use as new state
respOptional: pointer to an already allocated object to contain information in case of failure
Returns
Status code of the operation: InferenceEngine::OK (0) for success

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