OutPortId Class Reference

#include <corenodes_helpers.h>

Inheritance diagram for OutPortId:

Detailed Description

An OutPortId identifies an output port of a core node or micro node (see CoreNodeBaseInterface). It can be given either by a port name or by a port index.

Public Member Functions

 OutPortId ()
 
MAXON_IMPLICIT OutPortId (const Id &name)
 
MAXON_IMPLICIT OutPortId (Int index)
 
- Public Member Functions inherited from PortId
 MAXON_OPERATOR_EQUALITY (PortId, _indexDir, _name)
 
Bool IsIndex () const
 
Bool IsName () const
 
Bool IsPopulated () const
 
Bool IsEmpty () const
 
Int GetIndex () const
 
const IdGetName () const
 
PORT_DIR GetDirection () const
 
 PortId (PORT_DIR dir, const Id &name)
 
 PortId (PORT_DIR dir, Int index)
 
 PortId (PORT_DIR dir=PORT_DIR::INPUT)
 
String ToString (const FormatStatement *fs=nullptr) const
 

Static Public Member Functions

static MAXON_ATTRIBUTE_FORCE_INLINE const OutPortIdNullValue ()
 

Static Public Attributes

static constexpr WIRETYPE DEFAULT_WIRE
 

Static Private Attributes

static const OutPortId _nullValue
 

Additional Inherited Members

- Protected Attributes inherited from PortId
Int _indexDir
 
Id _name
 

Constructor & Destructor Documentation

◆ OutPortId() [1/3]

OutPortId ( )

Constructs an empty OutPortId (without name or index).

◆ OutPortId() [2/3]

MAXON_IMPLICIT OutPortId ( const Id name)

Constructs a new OutPortId given by a port name.

Parameters
[in]nameThe port name to use for the OutPortId.

◆ OutPortId() [3/3]

Constructs a new OutPortId given by a port index.

Parameters
[in]indexThe port index to use for the OutPortId.

Member Function Documentation

◆ NullValue()

static MAXON_ATTRIBUTE_FORCE_INLINE const OutPortId& NullValue ( )
static

Member Data Documentation

◆ DEFAULT_WIRE

constexpr WIRETYPE DEFAULT_WIRE
staticconstexpr

◆ _nullValue

const OutPortId _nullValue
staticprivate