NOCConnection

Object
- com.xilinx.rapidwright.design.noc.NOCConnection

All Implemented Interfaces:

Serializable
```
public class NOCConnection
extends Object
implements Serializable
```
Represents a NOC connection between two client endpoints.

Since:

2022.1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`NOCConnection()` Creates an empty NOC connection.
`NOCConnection(org.json.JSONObject json, NOCDesign nd)` Creates a NOC connection from a JSON path description.
`NOCConnection(NOCMaster source, NOCSlave dest, NOCConnection templatePath)` Creates a NOC connection by copying traffic properties from a template path.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChannel(NOCChannel net)` Adds a channel to this connection.
`void`	`checkUnsupportedFields(org.json.JSONObject json)` Checks whether a JSON path description contains fields that are not supported.
`HashSet<String>`	`getAllComponents()` Gets all physical components used by this connection.
`Map<ChannelType,NOCChannel>`	`getChannels()` Gets the map of channels that pertain to this connection.
`CommunicationType`	`getCommType()` Gets the communication type associated with this connection.
`NOCSlave`	`getDest()` Gets the destination or NOC slave for this connection.
`int`	`getEstimatedReadBandwidth()` Gets the estimated read bandwidth in MB/s of this connection.
`int`	`getEstimatedWriteBandwidth()` Gets the estimated write bandwidth in MB/s of this connection.
`String`	`getExclusiveGroup()` Gets the exclusive group name for this connection.
`int`	`getPhase()` Gets the traffic phase for this connection.
`String`	`getPort()` Gets the port name associated with this connection.
`int`	`getReadAverageBurst()` Gets the average read burst length for this connection.
`int`	`getReadBandwidth()` Gets the read bandwidth in MB/s of this connection.
`int`	`getReadLatency()` Gets the read latency for this connection in cycles.
`org.json.JSONObject`	`getSolutionJSONObject()` Converts this connection to its solution JSON representation.
`NOCMaster`	`getSource()` Gets the source or NOC master for this connection.
`org.json.JSONObject`	`getTrafficJSONObject()` Converts this connection to its traffic JSON representation.
`int`	`getWriteAverageBurst()` Gets the average write burst length for this connection.
`int`	`getWriteBandwidth()` Gets the write bandwidth in MB/s of this connection.
`int`	`getWriteLatency()` Gets the write latency for this connection in cycles.
`boolean`	`isDestLocked()` Checks whether this connection destination is locked.
`boolean`	`isPathLocked()` Checks whether this connection path is locked.
`boolean`	`isRouted()` Checks if this connection is routed.
`boolean`	`isSourceLocked()` Checks whether this connection source is locked.
`void`	`parseRoute(org.json.JSONObject json)` Parses routed solution data into this connection.
`void`	`removeChannel(ChannelType nc)` Removes a channel from this connection.
`void`	`setChannels(Map<ChannelType,NOCChannel> nets)` Sets the channels that pertain to this connection.
`void`	`setCommType(CommunicationType commType)` Sets the communication type associated with this connection.
`void`	`setDest(NOCSlave dest)` Sets the destination slave client for this connection.
`void`	`setDestLocked(boolean isDestLocked)` Sets whether this connection destination is locked.
`void`	`setEstimatedReadBandwidth(int estReadBandwidth)` Sets the estimated read bandwidth in MB/s for this connection.
`void`	`setEstimatedWriteBandwidth(int estWriteBandwidth)` Sets the estimated write bandwidth in MB/s for this connection.
`void`	`setExclusiveGroup(String exclusiveGroup)` Sets the exclusive group name for this connection.
`void`	`setPathLocked(boolean isPathLocked)` Sets whether this connection path is locked.
`void`	`setPhase(int phase)` Sets the traffic phase for this connection.
`void`	`setPort(String port)` Sets the port name associated with this connection.
`void`	`setReadAverageBurst(int readAverageBurst)` Sets the average read burst length for this connection.
`void`	`setReadBandwidth(int readBandwidth)` Sets the read bandwidth in MB/s for this connection.
`void`	`setReadLatency(int readLatency)` Sets the read latency for this connection in cycles.
`void`	`setRouted(boolean isRouted)` Sets whether this connection is routed.
`void`	`setSource(NOCMaster source)` Sets the source master client for this connection.
`void`	`setSourceLocked(boolean isSourceLocked)` Sets whether this connection source is locked.
`void`	`setWriteAverageBurst(int writeAverageBurst)` Sets the average write burst length for this connection.
`void`	`setWriteBandwidth(int writeBandwidth)` Sets the write bandwidth in MB/s for this connection.
`void`	`setWriteLatency(int writeLatency)` Sets the write latency for this connection in cycles.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NOCConnection
```
public NOCConnection()
```
    Creates an empty NOC connection.
    
    Since:
    
    2026.1.0
  - NOCConnection
```
public NOCConnection(NOCMaster source,
                     NOCSlave dest,
                     NOCConnection templatePath)
```
    Creates a NOC connection by copying traffic properties from a template path.
    
    Parameters:
    
    source - The source master client.
    
    dest - The destination slave client.
    
    templatePath - The connection that provides the traffic properties to copy.
    
    Since:
    
    2026.1.0
  - NOCConnection
```
public NOCConnection(org.json.JSONObject json,
                     NOCDesign nd)
```
    Creates a NOC connection from a JSON path description.
    
    Parameters:
    
    json - The JSON path description.
    
    nd - The NOC design containing the referenced clients.
    
    Since:
    
    2026.1.0
- Method Detail
  - checkUnsupportedFields
```
public void checkUnsupportedFields(org.json.JSONObject json)
```
    Checks whether a JSON path description contains fields that are not supported.
    
    Parameters:
    
    json - The JSON path description to check.
    
    Since:
    
    2026.1.0
  - getTrafficJSONObject
```
public org.json.JSONObject getTrafficJSONObject()
```
    Converts this connection to its traffic JSON representation.
    
    Returns:
    
    The traffic JSON representation of this connection.
    
    Since:
    
    2026.1.0
  - getSource
```
public NOCMaster getSource()
```
    Gets the source or NOC master for this connection.
    
    Returns:
    
    The source or NOC master for this connection
    
    Since:
    
    2022.1.0
  - getDest
```
public NOCSlave getDest()
```
    Gets the destination or NOC slave for this connection.
    
    Returns:
    
    The destination or NOC slave for this connection
    
    Since:
    
    2022.1.0
  - getPhase
```
public int getPhase()
```
    Gets the traffic phase for this connection.
    
    Returns:
    
    The traffic phase for this connection.
    
    Since:
    
    2026.1.0
  - setPhase
```
public void setPhase(int phase)
```
    Sets the traffic phase for this connection.
    
    Parameters:
    
    phase - The traffic phase to set.
    
    Since:
    
    2026.1.0
  - getPort
```
public String getPort()
```
    Gets the port name associated with this connection.
    
    Returns:
    
    Port name associated with this connection.
    
    Since:
    
    2022.1.0
  - setPort
```
public void setPort(String port)
```
    Sets the port name associated with this connection.
    
    Parameters:
    
    port - The port name to set.
    
    Since:
    
    2026.1.0
  - getCommType
```
public CommunicationType getCommType()
```
    Gets the communication type associated with this connection.
    
    Returns:
    
    The communication type associated with this connection.
    
    Since:
    
    2022.1.0
  - setCommType
```
public void setCommType(CommunicationType commType)
```
    Sets the communication type associated with this connection.
    
    Parameters:
    
    commType - The communication type to set.
    
    Since:
    
    2026.1.0
  - getReadBandwidth
```
public int getReadBandwidth()
```
    Gets the read bandwidth in MB/s of this connection.
    
    Returns:
    
    The read bandwidth in MB/s of this connection.
    
    Since:
    
    2022.1.0
  - setReadBandwidth
```
public void setReadBandwidth(int readBandwidth)
```
    Sets the read bandwidth in MB/s for this connection.
    
    Parameters:
    
    readBandwidth - The read bandwidth in MB/s.
    
    Since:
    
    2026.1.0
  - getWriteBandwidth
```
public int getWriteBandwidth()
```
    Gets the write bandwidth in MB/s of this connection.
    
    Returns:
    
    The write bandwidth in MB/s of this connection.
    
    Since:
    
    2022.1.0
  - setWriteBandwidth
```
public void setWriteBandwidth(int writeBandwidth)
```
    Sets the write bandwidth in MB/s for this connection.
    
    Parameters:
    
    writeBandwidth - The write bandwidth in MB/s.
    
    Since:
    
    2026.1.0
  - getEstimatedReadBandwidth
```
public int getEstimatedReadBandwidth()
```
    Gets the estimated read bandwidth in MB/s of this connection.
    
    Returns:
    
    The estimated read bandwidth in MB/s of this connection.
    
    Since:
    
    2022.1.0
  - setEstimatedReadBandwidth
```
public void setEstimatedReadBandwidth(int estReadBandwidth)
```
    Sets the estimated read bandwidth in MB/s for this connection.
    
    Parameters:
    
    estReadBandwidth - The estimated read bandwidth in MB/s.
    
    Since:
    
    2026.1.0
  - getEstimatedWriteBandwidth
```
public int getEstimatedWriteBandwidth()
```
    Gets the estimated write bandwidth in MB/s of this connection.
    
    Returns:
    
    The estimated write bandwidth in MB/s of this connection.
    
    Since:
    
    2022.1.0
  - setEstimatedWriteBandwidth
```
public void setEstimatedWriteBandwidth(int estWriteBandwidth)
```
    Sets the estimated write bandwidth in MB/s for this connection.
    
    Parameters:
    
    estWriteBandwidth - The estimated write bandwidth in MB/s.
    
    Since:
    
    2026.1.0
  - getReadLatency
```
public int getReadLatency()
```
    Gets the read latency for this connection in cycles.
    
    Returns:
    
    The read latency for this connection in cycles.
    
    Since:
    
    2022.1.0
  - setReadLatency
```
public void setReadLatency(int readLatency)
```
    Sets the read latency for this connection in cycles.
    
    Parameters:
    
    readLatency - The read latency in cycles.
    
    Since:
    
    2026.1.0
  - getWriteLatency
```
public int getWriteLatency()
```
    Gets the write latency for this connection in cycles.
    
    Returns:
    
    The write latency for this connection in cycles.
    
    Since:
    
    2022.1.0
  - setWriteLatency
```
public void setWriteLatency(int writeLatency)
```
    Sets the write latency for this connection in cycles.
    
    Parameters:
    
    writeLatency - The write latency in cycles.
    
    Since:
    
    2026.1.0
  - getReadAverageBurst
```
public int getReadAverageBurst()
```
    Gets the average read burst length for this connection.
    
    Returns:
    
    The average read burst length for this connection.
    
    Since:
    
    2026.1.0
  - setReadAverageBurst
```
public void setReadAverageBurst(int readAverageBurst)
```
    Sets the average read burst length for this connection.
    
    Parameters:
    
    readAverageBurst - The average read burst length to set.
    
    Since:
    
    2026.1.0
  - getWriteAverageBurst
```
public int getWriteAverageBurst()
```
    Gets the average write burst length for this connection.
    
    Returns:
    
    The average write burst length for this connection.
    
    Since:
    
    2026.1.0
  - setWriteAverageBurst
```
public void setWriteAverageBurst(int writeAverageBurst)
```
    Sets the average write burst length for this connection.
    
    Parameters:
    
    writeAverageBurst - The average write burst length to set.
    
    Since:
    
    2026.1.0
  - getChannels
```
public Map<ChannelType,NOCChannel> getChannels()
```
    Gets the map of channels that pertain to this connection. The map is keyed by the channel type.
    
    Returns:
    
    The map of channel types to channels in this connection.
    
    Since:
    
    2022.1.0
  - setChannels
```
public void setChannels(Map<ChannelType,NOCChannel> nets)
```
    Sets the channels that pertain to this connection.
    
    Parameters:
    
    nets - The map of channel types to channels to set.
    
    Since:
    
    2026.1.0
  - addChannel
```
public void addChannel(NOCChannel net)
```
    Adds a channel to this connection.
    
    Parameters:
    
    net - The channel to add.
    
    Since:
    
    2026.1.0
  - removeChannel
```
public void removeChannel(ChannelType nc)
```
    Removes a channel from this connection.
    
    Parameters:
    
    nc - The channel type to remove.
    
    Since:
    
    2026.1.0
  - isRouted
```
public boolean isRouted()
```
    Checks if this connection is routed.
    
    Returns:
    
    True if this connection is routed, false otherwise.
    
    Since:
    
    2022.1.0
  - setRouted
```
public void setRouted(boolean isRouted)
```
    Sets whether this connection is routed.
    
    Parameters:
    
    isRouted - True if this connection is routed, false otherwise.
    
    Since:
    
    2026.1.0
  - isPathLocked
```
public boolean isPathLocked()
```
    Checks whether this connection path is locked.
    
    Returns:
    
    True if the path is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - setPathLocked
```
public void setPathLocked(boolean isPathLocked)
```
    Sets whether this connection path is locked.
    
    Parameters:
    
    isPathLocked - True if the path is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - isSourceLocked
```
public boolean isSourceLocked()
```
    Checks whether this connection source is locked.
    
    Returns:
    
    True if the source is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - setSourceLocked
```
public void setSourceLocked(boolean isSourceLocked)
```
    Sets whether this connection source is locked.
    
    Parameters:
    
    isSourceLocked - True if the source is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - isDestLocked
```
public boolean isDestLocked()
```
    Checks whether this connection destination is locked.
    
    Returns:
    
    True if the destination is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - setDestLocked
```
public void setDestLocked(boolean isDestLocked)
```
    Sets whether this connection destination is locked.
    
    Parameters:
    
    isDestLocked - True if the destination is locked, false otherwise.
    
    Since:
    
    2026.1.0
  - setSource
```
public void setSource(NOCMaster source)
```
    Sets the source master client for this connection.
    
    Parameters:
    
    source - The source master client to set.
    
    Since:
    
    2026.1.0
  - setDest
```
public void setDest(NOCSlave dest)
```
    Sets the destination slave client for this connection.
    
    Parameters:
    
    dest - The destination slave client to set.
    
    Since:
    
    2026.1.0
  - getExclusiveGroup
```
public String getExclusiveGroup()
```
    Gets the exclusive group name for this connection.
    
    Returns:
    
    The exclusive group name for this connection.
    
    Since:
    
    2026.1.0
  - setExclusiveGroup
```
public void setExclusiveGroup(String exclusiveGroup)
```
    Sets the exclusive group name for this connection.
    
    Parameters:
    
    exclusiveGroup - The exclusive group name to set.
    
    Since:
    
    2026.1.0
  - parseRoute
```
public void parseRoute(org.json.JSONObject json)
```
    Parses routed solution data into this connection.
    
    Parameters:
    
    json - The JSON route description to parse.
    
    Since:
    
    2026.1.0
  - getSolutionJSONObject
```
public org.json.JSONObject getSolutionJSONObject()
```
    Converts this connection to its solution JSON representation.
    
    Returns:
    
    The solution JSON representation of this connection.
    
    Since:
    
    2026.1.0
  - getAllComponents
```
public HashSet<String> getAllComponents()
```
    Gets all physical components used by this connection.
    
    Returns:
    
    The physical component names used by this connection.
    
    Since:
    
    2026.1.0

Class NOCConnection

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

NOCConnection

NOCConnection

NOCConnection

Method Detail

checkUnsupportedFields

getTrafficJSONObject

getSource

getDest

getPhase

setPhase

getPort

setPort

getCommType

setCommType

getReadBandwidth

setReadBandwidth

getWriteBandwidth

setWriteBandwidth

getEstimatedReadBandwidth

setEstimatedReadBandwidth

getEstimatedWriteBandwidth

setEstimatedWriteBandwidth

getReadLatency

setReadLatency

getWriteLatency

setWriteLatency

getReadAverageBurst

setReadAverageBurst

getWriteAverageBurst

setWriteAverageBurst

getChannels

setChannels

addChannel

removeChannel

isRouted

setRouted

isPathLocked

setPathLocked

isSourceLocked

setSourceLocked

isDestLocked

setDestLocked

setSource

setDest

getExclusiveGroup

setExclusiveGroup

parseRoute

getSolutionJSONObject

getAllComponents