scc 2025.09
SystemC components library
tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL > Struct Template Reference

Definition of the tlm_network_initiator_socket class. More...

#include <tlm_network_sockets.h>

Inheritance diagram for tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >:
Collaboration diagram for tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >:

Public Types

using protocol_types = TYPES
using transaction_type = typename TYPES::tlm_payload_type
using phase_type = typename TYPES::tlm_phase_type
using base_class = tlm_base_initiator_socket<0, tlm_network_fw_transport_if<TYPES>, tlm_network_bw_transport_if<TYPES>, N, POL>
using fw_interface_type = tlm_network_fw_transport_if<TYPES>
using bw_interface_type = tlm_network_bw_transport_if<TYPES>
using port_type = sc_core::sc_port<fw_interface_type, N, POL>
using export_type = sc_core::sc_export<bw_interface_type>

Public Member Functions

 tlm_network_initiator_socket ()
 Constructor with default name.
 tlm_network_initiator_socket (const char *name)
 Constructor with specified name.
virtual ~tlm_network_initiator_socket ()=default
virtual const char * kind () const
virtual type_index get_protocol_types () const

Detailed Description

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
struct tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >

Definition of the tlm_network_initiator_socket class.

This socket is used to initiate transactions to a target.

Definition at line 87 of file tlm_network_sockets.h.

Member Typedef Documentation

◆ base_class

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::base_class = tlm_base_initiator_socket<0, tlm_network_fw_transport_if<TYPES>, tlm_network_bw_transport_if<TYPES>, N, POL>

Definition at line 94 of file tlm_network_sockets.h.

◆ bw_interface_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::bw_interface_type = tlm_network_bw_transport_if<TYPES>

Definition at line 97 of file tlm_network_sockets.h.

◆ export_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::export_type = sc_core::sc_export<bw_interface_type>

Definition at line 100 of file tlm_network_sockets.h.

◆ fw_interface_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::fw_interface_type = tlm_network_fw_transport_if<TYPES>

Definition at line 96 of file tlm_network_sockets.h.

◆ phase_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::phase_type = typename TYPES::tlm_phase_type

Definition at line 92 of file tlm_network_sockets.h.

◆ port_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::port_type = sc_core::sc_port<fw_interface_type, N, POL>

Definition at line 99 of file tlm_network_sockets.h.

◆ protocol_types

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::protocol_types = TYPES

Definition at line 90 of file tlm_network_sockets.h.

◆ transaction_type

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
using tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::transaction_type = typename TYPES::tlm_payload_type

Definition at line 91 of file tlm_network_sockets.h.

Constructor & Destructor Documentation

◆ tlm_network_initiator_socket() [1/2]

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::tlm_network_initiator_socket ( )
inline

Constructor with default name.

Initializes the tlm_network_initiator_socket object with a default name.

Definition at line 106 of file tlm_network_sockets.h.

◆ tlm_network_initiator_socket() [2/2]

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::tlm_network_initiator_socket ( const char * name)
inlineexplicit

Constructor with specified name.

Initializes the tlm_network_initiator_socket object with a specified name.

Parameters
nameThe name of the socket.

Definition at line 115 of file tlm_network_sockets.h.

◆ ~tlm_network_initiator_socket()

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
virtual tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::~tlm_network_initiator_socket ( )
virtualdefault

virtual destructor of the tlm_network_initiator_socket.

Member Function Documentation

◆ get_protocol_types()

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
virtual type_index tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::get_protocol_types ( ) const
inlinevirtual

Returns the type index of the protocol types associated with this socket.

Definition at line 128 of file tlm_network_sockets.h.

◆ kind()

template<unsigned PHITWIDTH, typename CMDENUM, typename TYPES = tlm_network_baseprotocol_types, int N = 1, sc_core::sc_port_policy POL = sc_core::SC_ONE_OR_MORE_BOUND>
virtual const char * tlm::nw::tlm_network_initiator_socket< PHITWIDTH, CMDENUM, TYPES, N, POL >::kind ( ) const
inlinevirtual

Provides the kind() method to retrieve the socket's kind as string.

Definition at line 124 of file tlm_network_sockets.h.


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