InPortId Class Reference

#include <corenodes_helpers.h>

Inheritance diagram for InPortId:

Detailed Description

An InPortId identifies an input 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
	InPortId ()
MAXON_IMPLICIT	InPortId (const Id &name)
	InPortId (const InternedId &name)
MAXON_IMPLICIT	InPortId (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 Id &	GetName () 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 InPortId &	DefaultValue ()

Static Public Attributes
static constexpr WIRETYPE	DEFAULT_WIRE

Static Private Attributes
static const InPortId	_defaultValue

Additional Inherited Members
Protected Attributes inherited from PortId
Int	_indexDir
Id	_name

Constructor & Destructor Documentation

InPortId() [1/4]

InPortId

(

)

Constructs an empty InPortId (without name or index).

InPortId() [2/4]

MAXON_IMPLICIT InPortId

(

const Id &

name

)

Constructs a new InPortId given by a port name.

Parameters

[in]

name

The port name to use for the InPortId.

InPortId() [3/4]

InPortId ( const InternedId &  name )

explicit

InPortId() [4/4]

MAXON_IMPLICIT InPortId

(

Int

index

)

Constructs a new InPortId given by a port index.

Parameters

[in]

index

The port index to use for the InPortId.

Member Function Documentation

DefaultValue()

static MAXON_ATTRIBUTE_FORCE_INLINE const InPortId& DefaultValue ( )

static

Member Data Documentation

DEFAULT_WIRE

constexpr WIRETYPE DEFAULT_WIRE

staticconstexpr

_defaultValue

const InPortId _defaultValue

staticprivate