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 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.
 
Parameter operator= (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 &
 
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/4]

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

Move constructor.

Parameters
parameter Parameter object

§ Parameter() [2/4]

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

Copy constructor.

Parameters
parameter Parameter object

§ Parameter() [3/4]

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
T Parameter type
U Identity type-transformation
Parameters
parameter object

§ Parameter() [4/4]

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

Constructor creates string parameter from char *.

Parameters
str char array

Member Function Documentation

§ as() [1/3]

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ as() [2/3]

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ as() [3/3]

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ 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
T Type 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
T type
Returns
casted object

§ operator T &() [1/2]

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ operator T &() [2/2]

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ operator T &&()

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

Dynamic cast to specified type

Template Parameters
T type
Returns
casted object

§ operator!=()

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

The comparison operator for the Parameter.

Parameters
rhs object to compare
Returns
true if objects aren't equal

§ operator=()

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

Copy operator for Parameter

Parameters
parameter Parameter object
Returns
Parameter

§ operator==()

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

The comparison operator for the Parameter.

Parameters
rhs object to compare
Returns
true if objects are equal

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