CIRCT  19.0.0git
Public Types | Public Member Functions | Protected Attributes | List of all members
esi::BundleType Class Reference

Bundles represent a collection of channels. More...

#include <Types.h>

Inheritance diagram for esi::BundleType:
Inheritance graph
Collaboration diagram for esi::BundleType:
Collaboration graph

Public Types

enum  Direction { To , From }
using ChannelVector = std::vector< std::tuple< std::string, Direction, const Type * > >
- Public Types inherited from esi::Type
using ID = std::string

Public Member Functions

 BundleType (const ID &id, const ChannelVector &channels)
const ChannelVectorgetChannels () const
std::ptrdiff_t getBitWidth () const override
- Public Member Functions inherited from esi::Type
 Type (const ID &id)
virtual ~Type ()=default
ID getID () const

Protected Attributes

ChannelVector channels
- Protected Attributes inherited from esi::Type
ID id

Detailed Description

Bundles represent a collection of channels.

Services exclusively expose bundles (sometimes of just one channel). As such, they are the type of accessible ports on an accelerator, from a host API perspective. TODO: Add a good description of direction?

Definition at line 44 of file Types.h.

Member Typedef Documentation

◆ ChannelVector

using esi::BundleType::ChannelVector = std::vector<std::tuple<std::string, Direction, const Type *> >

Definition at line 48 of file Types.h.

Member Enumeration Documentation

◆ Direction


Definition at line 46 of file Types.h.

Constructor & Destructor Documentation

◆ BundleType()

esi::BundleType::BundleType ( const ID id,
const ChannelVector channels 

Definition at line 51 of file Types.h.

Member Function Documentation

◆ getBitWidth()

std::ptrdiff_t esi::BundleType::getBitWidth ( ) const

Reimplemented from esi::Type.

Definition at line 55 of file Types.h.

◆ getChannels()

const ChannelVector& esi::BundleType::getChannels ( ) const

Member Data Documentation

◆ channels

ChannelVector esi::BundleType::channels

Definition at line 58 of file Types.h.

Referenced by getChannels().

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