HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_NodePorts Class Reference

#include <PDG_NodePorts.h>

+ Inheritance diagram for PDG_NodePorts:

Public Member Functions

int64 getMemoryUsage (bool inclusive) const
 Returns the total memory usage of this instance. More...
 
void sort (PDG_PortType port_type)
 
int count (PDG_PortType port_type) const
 Returns the total number of ports of the specified type. More...
 
const PDG_PortArrayports (PDG_PortType port_type) const
 Returns the array of ports for the specified type. More...
 
PDG_Portport (const UT_StringHolder &name) const
 
PDG_Portport (PDG_PortType port_type, int index) const
 
PDG_Portport (PDG_PortType port_type, const UT_StringHolder &name) const
 
template<typename... Args>
PDG_Portadd (Args &&...args)
 Adds a new port to the table. More...
 
bool remove (PDG_PortType port_type, const UT_StringHolder &name)
 Removes a port with the specified name and type. More...
 
void clear (PDG_PortType port_type)
 Clears all ports of the specified type. More...
 

Detailed Description

Definition at line 22 of file PDG_NodePorts.h.

Member Function Documentation

template<typename... Args>
PDG_Port* PDG_NodePorts::add ( Args &&...  args)
inline

Adds a new port to the table.

Definition at line 58 of file PDG_NodePorts.h.

void PDG_NodePorts::clear ( PDG_PortType  port_type)

Clears all ports of the specified type.

int PDG_NodePorts::count ( PDG_PortType  port_type) const
inline

Returns the total number of ports of the specified type.

Definition at line 34 of file PDG_NodePorts.h.

int64 PDG_NodePorts::getMemoryUsage ( bool  inclusive) const

Returns the total memory usage of this instance.

PDG_Port* PDG_NodePorts::port ( const UT_StringHolder name) const

Returns the first port that matches the specified name, regardless of port type. Returns nullptr if no port is found.

PDG_Port* PDG_NodePorts::port ( PDG_PortType  port_type,
int  index 
) const

Returns the port at the specified index and type, or nullptr if no port is found at that index

PDG_Port* PDG_NodePorts::port ( PDG_PortType  port_type,
const UT_StringHolder name 
) const

Returns the port with the specified name and type, or nullptr if no port exists with that name

const PDG_PortArray& PDG_NodePorts::ports ( PDG_PortType  port_type) const
inline

Returns the array of ports for the specified type.

Definition at line 38 of file PDG_NodePorts.h.

bool PDG_NodePorts::remove ( PDG_PortType  port_type,
const UT_StringHolder name 
)

Removes a port with the specified name and type.

void PDG_NodePorts::sort ( PDG_PortType  port_type)

Sorts the ports stored in this instance by there isOrdered flag, for the specified type.


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