Public Member Functions
InferenceEngine::Port Class Reference

This class is the main object to describe the Inference Engine port. More...

#include <ie_network.hpp>

Public Member Functions

  Port ()
  Default constructor of a port object.
 
  Port (const SizeVector &shapes, const Precision &precision=Precision::UNSPECIFIED)
  Constructor of a port object with shapes. More...
 
  Port (const Port &port)
  Copy constructor. More...
 
virtual  ~Port ()=default
  Virtual destructor.
 
bool  operator== (const Port &rhs) const
  Compares the given Port with the current one. More...
 
bool  operator!= (const Port &rhs) const
  Compares the given Port with the current one. More...
 
const SizeVector &  shape () const noexcept
  Returns a constant reference to a vector with shapes. Shapes should be initialized if shape is empty. More...
 
void  setShape (const SizeVector &shape)
  Sets new shapes for current port. More...
 
const std::map< std::string, Parameter > &  getParameters () const noexcept
  Returns a constant reference to parameters. More...
 
void  setParameters (const std::map< std::string, Parameter > &params) noexcept
  Sets new parameters for current port. More...
 
void  setParameter (const std::string &name, const Parameter &param)
  Sets the new parameter for current port. More...
 
const PortData::Ptr &  getData () const noexcept
  Returns port data. More...
 
void  setData (const PortData::Ptr &data)
  Sets new port data for current port. More...
 

Detailed Description

This class is the main object to describe the Inference Engine port.

Constructor & Destructor Documentation

§ Port() [1/2]

InferenceEngine::Port::Port ( const SizeVector &  shapes,
const Precision &  precision = Precision::UNSPECIFIED 
)
explicit

Constructor of a port object with shapes.

Parameters
shapes port shapes
precision Port precision

§ Port() [2/2]

InferenceEngine::Port::Port ( const Port &  port )

Copy constructor.

Parameters
port object to copy

Member Function Documentation

§ getData()

const PortData::Ptr& InferenceEngine::Port::getData ( ) const
noexcept

Returns port data.

Returns
Port data

§ getParameters()

const std::map<std::string, Parameter>& InferenceEngine::Port::getParameters ( ) const
noexcept

Returns a constant reference to parameters.

Returns
Map with parameters

§ operator!=()

bool InferenceEngine::Port::operator!= ( const Port &  rhs ) const

Compares the given Port with the current one.

Parameters
rhs Port to compare with
Returns
true if the given Port is NOT equal to the current one, false - otherwise

§ operator==()

bool InferenceEngine::Port::operator== ( const Port &  rhs ) const

Compares the given Port with the current one.

Parameters
rhs Port to compare with
Returns
true if the given Port is equal to the current one, false - otherwise

§ setData()

void InferenceEngine::Port::setData ( const PortData::Ptr &  data )

Sets new port data for current port.

Parameters
data Port data

§ setParameter()

void InferenceEngine::Port::setParameter ( const std::string &  name,
const Parameter &  param 
)

Sets the new parameter for current port.

Parameters
name Name of parameter
param New value

§ setParameters()

void InferenceEngine::Port::setParameters ( const std::map< std::string, Parameter > &  params )
noexcept

Sets new parameters for current port.

Parameters
params New parameters

§ setShape()

void InferenceEngine::Port::setShape ( const SizeVector &  shape )

Sets new shapes for current port.

Parameters
shape New shapes

§ shape()

const SizeVector& InferenceEngine::Port::shape ( ) const
noexcept

Returns a constant reference to a vector with shapes. Shapes should be initialized if shape is empty.

Returns
constant reference to shapes
The documentation for this class was generated from the following file: