InputPort.hpp

Go to the documentation of this file.

#pragma once
#include <Pothos/Config.hpp>
#include <Pothos/Object/Object.hpp>
#include <Pothos/Framework/DType.hpp>
#include <Pothos/Framework/Label.hpp>
#include <Pothos/Framework/BufferChunk.hpp>
#include <string>

namespace Pothos {

class InputPortImpl;
class WorkerActor;

class POTHOS_API InputPort
{
public:

    ~InputPort(void);

    int index(void) const;

    const std::string &name(void) const;

    const DType &dtype(void) const;

    const std::string &domain(void) const;

    const BufferChunk &buffer(void) const;

    size_t elements(void) const;

    unsigned long long totalElements(void) const;

    unsigned long long totalMessages(void) const;

    bool hasMessage(void) const;

    const LabelIteratorRange &labels(void) const;

    void removeLabel(const Label &label);

    void consume(const size_t numElements);

    Object popMessage(void);

    void setReserve(const size_t numElements);

    bool isSlot(void) const;

    void pushBuffer(const BufferChunk &buffer);

    void pushLabel(const Label &label);

    void pushMessage(const Object &message);

    void clear(void);

private:
    InputPortImpl *_impl;
    int _index;
    std::string _name;
    DType _dtype;
    std::string _domain;
    std::reference_wrapper<const BufferChunk> _buffer;
    size_t _elements;
    unsigned long long _totalElements;
    unsigned long long _totalMessages;
    LabelIteratorRange _labelIter;
    size_t _pendingElements;
    size_t _reserveElements;
    InputPort(InputPortImpl *);
    InputPort(const InputPort &):
        _buffer(BufferChunk::null())
    {} // non construction-copyable
    InputPort &operator=(const InputPort &){return *this;} // non copyable
    friend class WorkerActor;
};

} //namespace Pothos

inline int Pothos::InputPort::index(void) const
{
    return _index;
}

inline const std::string &Pothos::InputPort::name(void) const
{
    return _name;
}

inline const Pothos::DType &Pothos::InputPort::dtype(void) const
{
    return _dtype;
}

inline const std::string &Pothos::InputPort::domain(void) const
{
    return _domain;
}

inline const Pothos::BufferChunk &Pothos::InputPort::buffer(void) const
{
    return _buffer;
}

inline size_t Pothos::InputPort::elements(void) const
{
    return _elements;
}

inline unsigned long long Pothos::InputPort::totalElements(void) const
{
    return _totalElements;
}

inline unsigned long long Pothos::InputPort::totalMessages(void) const
{
    return _totalMessages;
}

inline const Pothos::LabelIteratorRange &Pothos::InputPort::labels(void) const
{
    return _labelIter;
}

inline void Pothos::InputPort::consume(const size_t numElements)
{
    _pendingElements += numElements;
}