HAL
hal::Endpoint Class Reference

#include <endpoint.h>

Collaboration diagram for hal::Endpoint:
Collaboration graph

Public Member Functions

bool operator== (const Endpoint &other) const
 
bool operator!= (const Endpoint &other) const
 
Gateget_gate () const
 
GatePinget_pin () const
 
Netget_net () const
 
bool is_source_pin () const
 
bool is_destination_pin () const
 

Friends

class NetlistInternalManager
 

Detailed Description

An endpoint comprises the pin of a gate, the respective gate, and the connected net.

Definition at line 42 of file endpoint.h.

Member Function Documentation

◆ get_gate()

Gate * hal::Endpoint::get_gate ( ) const

Get the gate associated with the endpoint.

Returns
The gate.

Definition at line 23 of file endpoint.cpp.

Referenced by hal::dataflow::Result::create_modules(), hal::endpoint_init(), hal::netlist_utils::get_complex_gate_chain(), hal::netlist_utils::get_gate_chain(), operator==(), and hal::TEST_F().

◆ get_net()

Net * hal::Endpoint::get_net ( ) const

Get the net associated with the endpoint.

Returns
The net.

Definition at line 33 of file endpoint.cpp.

Referenced by hal::endpoint_init(), operator==(), hal::netlist_utils::remove_buffers(), and hal::TEST_F().

◆ get_pin()

GatePin * hal::Endpoint::get_pin ( ) const

Get the pin associated with the endpoint.

Returns
The pin.

Definition at line 28 of file endpoint.cpp.

Referenced by hal::endpoint_init(), hal::netlist_utils::get_complex_gate_chain(), operator==(), hal::netlist_utils::remove_buffers(), and hal::TEST_F().

◆ is_destination_pin()

bool hal::Endpoint::is_destination_pin ( ) const

Checks whether the pin of the endpoint is a destination (input) pin.

Returns
True if the endpoint is an destination (input) pin, false otherwise.

Definition at line 38 of file endpoint.cpp.

Referenced by hal::endpoint_init(), hal::Net::is_a_destination(), and operator==().

◆ is_source_pin()

bool hal::Endpoint::is_source_pin ( ) const

Checks whether the pin of the endpoint is a source (output) pin.

Returns
True if the endpoint is an source (output) pin, false otherwise.

Definition at line 43 of file endpoint.cpp.

Referenced by hal::endpoint_init(), and hal::Net::is_a_source().

◆ operator!=()

bool hal::Endpoint::operator!= ( const Endpoint other) const

Check whether two endpoints are unequal.

Parameters
[in]other- The endpoint to compare against.
Returns
True if both endpoints are unequal, false otherwise.

Definition at line 18 of file endpoint.cpp.

◆ operator==()

bool hal::Endpoint::operator== ( const Endpoint other) const

Check whether two endpoints are equal.

Parameters
[in]other- The endpoint to compare against.
Returns
True if both endpoints are equal, false otherwise.

Definition at line 13 of file endpoint.cpp.

References get_gate(), get_net(), get_pin(), and is_destination_pin().

Friends And Related Function Documentation

◆ NetlistInternalManager

friend class NetlistInternalManager
friend

Definition at line 97 of file endpoint.h.


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