UNI_ConstPort Class Reference

#include <UNI_Port.h>

Inheritance diagram for UNI_ConstPort:

Public Member Functions
UNI_NodeID	node () const
	Returns the UNI_Node that owns this port. More...
UNI_PortKind	portKind () const
	Returns what kind of a port this is: input or output. More...
UT_StringHolder	label () const
	Returns the label for the port. More...
UT_StringHolder	name () const
	Returns the name of the port. More...
bool	canSetName () const
	Return true if the port name can be changed. More...
UT_StringHolder	typeName () const
	Returns the name of the data type for the given port. More...
UT_StringHolder	colorName () const
UNI_PortShape	shape () const
	Returns the UI shape of the port socket. More...
UNI_WireIDList	srcWires () const
UNI_WireIDList	dstWires () const
Public Member Functions inherited from UNI_ConstItem< UNI_PortID >
	UNI_ConstItem ()=default
	Constructor. More...
	UNI_ConstItem (const UNI_ConstGraphHandle &graph_handle, UNI_PortIDid)
	UNI_ConstItem (UNI_ConstGraphHandle &&graph_handle, UNI_PortIDid)
	Constructor with r-value for the intrusive graph pointer. More...
const UNI_Graph *	graph () const
	Returns the graph inside which the node lives. More...
UNI_PortID	id () const
	Returns the ID of the node in the graph. More...
bool	isValid () const
	operator bool () const

Additional Inherited Members
Protected Member Functions inherited from UNI_ConstItem< UNI_PortID >
const UNI_ConstGraphHandle &	graphHandle () const
	Returns the underlying graph handle. More...

Detailed Description

Definition at line 19 of file UNI_Port.h.

Member Function Documentation

bool UNI_ConstPort::canSetName ( ) const

inline

Return true if the port name can be changed.

Definition at line 50 of file UNI_Port.h.

UT_StringHolder UNI_ConstPort::colorName ( ) const

inline

Returns the name of the UI color for the given port. The color name adheres to the UIgetMiscColor() conventions.

Definition at line 63 of file UNI_Port.h.

UNI_WireIDList UNI_ConstPort::dstWires ( ) const

inline

Return wires that are destinations from this port (where this port is the source of the wire).

Definition at line 83 of file UNI_Port.h.

UT_StringHolder UNI_ConstPort::label ( ) const

inline

Returns the label for the port.

Definition at line 38 of file UNI_Port.h.

UT_StringHolder UNI_ConstPort::name ( void  ) const

inline

Returns the name of the port.

Definition at line 44 of file UNI_Port.h.

UNI_NodeID UNI_ConstPort::node ( ) const

inline

Returns the UNI_Node that owns this port.

Definition at line 26 of file UNI_Port.h.

UNI_PortKind UNI_ConstPort::portKind ( ) const

inline

Returns what kind of a port this is: input or output.

Definition at line 32 of file UNI_Port.h.

UNI_PortShape UNI_ConstPort::shape ( ) const

inline

Returns the UI shape of the port socket.

Definition at line 69 of file UNI_Port.h.

UNI_WireIDList UNI_ConstPort::srcWires ( ) const

inline

Return wires that are sources to this port (where this port is the destination of the wire).

Definition at line 76 of file UNI_Port.h.

UT_StringHolder UNI_ConstPort::typeName ( ) const

inline

Returns the name of the data type for the given port.

Definition at line 56 of file UNI_Port.h.

---

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

• UNI/UNI_Port.h