The BLOCKS SDK
Block::ConnectionPort Struct Reference

Description

These are the edge-connectors that a device may have.

Public Member Functions

bool operator== (const ConnectionPort &) const noexcept
 
bool operator!= (const ConnectionPort &) const noexcept
 

Public Attributes

DeviceEdge edge
 The side of the device on which this port is located. More...
 
int index
 The index of this port along the device edge. More...
 

Public Types

enum  DeviceEdge { DeviceEdge::north, DeviceEdge::south, DeviceEdge::east, DeviceEdge::west }
 

Member Function Documentation

§ operator==()

bool Block::ConnectionPort::operator== ( const ConnectionPort ) const
noexcept

§ operator!=()

bool Block::ConnectionPort::operator!= ( const ConnectionPort ) const
noexcept

Member Enumeration Documentation

§ DeviceEdge

Enumerator
north 
south 
east 
west 

Member Data Documentation

§ edge

DeviceEdge Block::ConnectionPort::edge

The side of the device on which this port is located.

§ index

int Block::ConnectionPort::index

The index of this port along the device edge.

For north and south edges, index 0 is the left-most port. For east and west edges, index 0 is the top-most port.


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