Data Structures | Public Member Functions
InferenceEngine::Parameter Class Reference

This class represents an object to work with different parameters. More...

#include <ie_parameter.hpp>

Public Member Functions

 Parameter ()=default
 Default constructor.
 
 Parameter (Parameter &&parameter) noexcept
 Move constructor. More...
 
 Parameter (const std::shared_ptr< ngraph::Variant > &var)
 Creates parameter from variant. This method creates empty parameter if variant doesn't contain Parameter. More...
 
 Parameter (const Parameter &parameter)
 Copy constructor. More...
 
template<class T , typename = typename std::enable_if<!std::is_same<typename std::decay<T>::type, Parameter>::value>::type>
 Parameter (T &&parameter)
 Constructor creates parameter with object. More...
 
 Parameter (const char *str)
 Constructor creates string parameter from char *. More...
 
virtual ~Parameter ()
 Destructor.
 
Parameteroperator= (const Parameter &parameter)
 
void clear ()
 
bool empty () const noexcept
 
template<class T >
bool is () const
 
template<typename T >
T && as () &&
 
template<class T >
T & as () &
 
template<class T >
const T & as () const &
 
template<class T >
 operator T&& () &&
 
template<class T >
 operator T & () &
 
template<class T >
 operator const T & () const &
 
std::shared_ptr< ngraph::Variant > asVariant () const
 Converts parameter to shared pointer on ngraph::Variant. More...
 
 operator std::shared_ptr< ngraph::Variant > () const
 Casts to shared pointer on ngraph::Variant. More...
 
template<class T >
 operator T & () const &
 
bool operator== (const Parameter &rhs) const
 The comparison operator for the Parameter. More...
 
bool operator!= (const Parameter &rhs) const
 The comparison operator for the Parameter. More...
 

Detailed Description

This class represents an object to work with different parameters.

Constructor & Destructor Documentation

§ Parameter() [1/5]

InferenceEngine::Parameter::Parameter ( Parameter &&  parameter)
inlinenoexcept

Move constructor.

Parameters
parameterParameter object

§ Parameter() [2/5]

InferenceEngine::Parameter::Parameter ( const std::shared_ptr< ngraph::Variant > &  var)

Creates parameter from variant. This method creates empty parameter if variant doesn't contain Parameter.

Parameters
varngraph variant

§ Parameter() [3/5]

InferenceEngine::Parameter::Parameter ( const Parameter parameter)
inline

Copy constructor.

Parameters
parameterParameter object

§ Parameter() [4/5]

template<class T , typename = typename std::enable_if<!std::is_same<typename std::decay<T>::type, Parameter>::value>::type>
InferenceEngine::Parameter::Parameter ( T &&  parameter)
inline

Constructor creates parameter with object.

Template Parameters
TParameter type
UIdentity type-transformation
Parameters
parameterobject

§ Parameter() [5/5]

InferenceEngine::Parameter::Parameter ( const char *  str)
inline

Constructor creates string parameter from char *.

Parameters
strchar array

Member Function Documentation

§ as() [1/3]

template<typename T >
T&& InferenceEngine::Parameter::as ( )
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ as() [2/3]

template<class T >
T& InferenceEngine::Parameter::as ( )
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ as() [3/3]

template<class T >
const T& InferenceEngine::Parameter::as ( ) const
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ asVariant()

std::shared_ptr<ngraph::Variant> InferenceEngine::Parameter::asVariant ( ) const

Converts parameter to shared pointer on ngraph::Variant.

Returns
shared pointer on ngraph::Variant

§ clear()

void InferenceEngine::Parameter::clear ( )
inline

Remove a value from parameter

§ empty()

bool InferenceEngine::Parameter::empty ( ) const
inlinenoexcept

Checks that parameter contains a value

Returns
false if parameter contains a value else false

§ is()

template<class T >
bool InferenceEngine::Parameter::is ( ) const
inline

Checks the type of value

Template Parameters
TType of value
Returns
true if type of value is correct

§ operator const T &()

template<class T >
InferenceEngine::Parameter::operator const T & ( ) const
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ operator std::shared_ptr< ngraph::Variant >()

InferenceEngine::Parameter::operator std::shared_ptr< ngraph::Variant > ( ) const
inline

Casts to shared pointer on ngraph::Variant.

Returns
shared pointer on ngraph::Variant

§ operator T &() [1/2]

template<class T >
InferenceEngine::Parameter::operator T& ( )
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ operator T &() [2/2]

template<class T >
InferenceEngine::Parameter::operator T& ( ) const
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ operator T&&()

template<class T >
InferenceEngine::Parameter::operator T && ( )
inline

Dynamic cast to specified type

Template Parameters
Ttype
Returns
casted object

§ operator!=()

bool InferenceEngine::Parameter::operator!= ( const Parameter rhs) const
inline

The comparison operator for the Parameter.

Parameters
rhsobject to compare
Returns
true if objects aren't equal

§ operator=()

Parameter& InferenceEngine::Parameter::operator= ( const Parameter parameter)
inline

Copy operator for Parameter

Parameters
parameterParameter object
Returns
Parameter

§ operator==()

bool InferenceEngine::Parameter::operator== ( const Parameter rhs) const
inline

The comparison operator for the Parameter.

Parameters
rhsobject to compare
Returns
true if objects are equal

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