Unit port

class CUnitPort

Description of the unit port.

The main purpose is connecting to material streams.

Public Functions

CUnitPort(std::string _name, EUnitPort _type)

Constructs unit port with the given name and type.

Parameters
  • _name – Name of the port.

  • _type – Type of the port.

std::string GetName() const

Returns port’s name.

Returns

Name of the port.

void SetName(const std::string &_name)

Sets port’s name.

Parameters

_name – New name of the port.

EUnitPort GetType() const

Returns port’s type.

Returns

Type of the port.

void SetType(EUnitPort _type)

Sets port’s type.

Parameters

_type – New type of the port.

std::string GetStreamKey() const

Returns key of the stream, connected to this port.

Returns

Key of the stream connected to the port.

void SetStreamKey(const std::string &_key)

Sets key of the stream, connected to this port.

Parameters

_key – New key of the stream.

CStream *GetStream() const

Returns stream, connected to this port.

Returns

Pointer to the stream, currently connected to this port.

void SetStream(CStream *_stream)

Sets stream, connected to this port.

Parameters

_stream – Pointer no a new stream.