NOCDesign

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

All Implemented Interfaces:

Serializable
```
public class NOCDesign
extends Object
implements Serializable
```
Represents the Network-on-Chip solution for the current design

Since:

2022.1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

NOCDesign()
Creates an empty NOC design.

NOCDesign(Design d)
Creates a NOC design associated with a RapidWright design.

Constructors
Constructor and Description
`NOCDesign()` Creates an empty NOC design.
`NOCDesign(Design d)` Creates a NOC design associated with a RapidWright design.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClient(NOCClient nc)` Adds a NOC client to this design.
`void`	`addConnection(NOCConnection np)` Adds a NOC connection to this design.
`boolean`	`areDestIDsLocked()` Checks whether all destination IDs are locked.
`void`	`clearSolution()` Clears the NOC solution if it exists.
`NOCClient`	`copyClient(NOCClient orig, String name)` Copy a client from another NOCDesign into this NOCDesign under a new name.
`List<NOCConnection>`	`getAllConnections()` Gets all the connections that are part of this NOC design.
`Map<String,NOCClient>`	`getClients()` Gets all NOC clients part of this NOC design.
`Design`	`getDesign()` Gets the main design corresponding to this NOCDesign
`List<String>`	`getDFXCells()` Gets DFX cell paths in this NOC design.
`int`	`getFrequency()` Gets the target frequency of this NOC design.
`Map<String,NOCMaster>`	`getMasterClients()` Gets the map of master clients in the NOC design.
`Map<String,NOCSlave>`	`getSlaveClients()` Gets the map of slave clients in the NOC design.
`SolutionType`	`getSolutionType()` Gets the current NOC solution type.
`boolean`	`isRouted()` Checks if the NOC design is routed.
`void`	`loadSolution(InputStream in)` Loads NOC solution data from a JSON input stream.
`void`	`loadTraffic(InputStream in)` Loads NOC traffic data from a JSON input stream.
`void`	`removeClient(String clientName)` Removes a NOC client from this design by name.
`void`	`removeConnection(NOCConnection np)` Removes a NOC connection from this design.
`void`	`setAllDestIDsLocked(boolean lockAllDestIDs)` Sets whether all destination IDs are locked.
`void`	`setDesign(Design design)` Sets the main design corresponding to this NOCDesign
`void`	`setFrequency(int nocFrequency)` Sets the target NOC frequency.
`void`	`setIsRouted(boolean isRouted)` Sets whether this NOC design has routed solution data.
`void`	`setSolutionType(SolutionType solutionType)` Sets the current NOC solution type.
`void`	`writeSolution(OutputStream out)` Writes NOC solution data to a JSON output stream.
`void`	`writeTraffic(OutputStream out)` Writes NOC traffic data to a JSON output stream.

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

- Constructor Detail
  - NOCDesign
```
public NOCDesign()
```
    Creates an empty NOC design.
    
    Since:
    
    2026.1.0
  - NOCDesign
```
public NOCDesign(Design d)
```
    Creates a NOC design associated with a RapidWright design.
    
    Parameters:
    
    d - The RapidWright design to associate with this NOC design.
    
    Since:
    
    2026.1.0
- Method Detail
  - setDesign
```
public void setDesign(Design design)
```
    Sets the main design corresponding to this NOCDesign
    
    Parameters:
    
    design - The design to which this NOC solution belongs
    
    Since:
    
    2022.1.0
  - getDesign
```
public Design getDesign()
```
    Gets the main design corresponding to this NOCDesign
    
    Returns:
    
    The design to which this NOC solution belongs
    
    Since:
    
    2022.1.0
  - getMasterClients
```
public Map<String,NOCMaster> getMasterClients()
```
    Gets the map of master clients in the NOC design. The map is keyed by client name.
    
    Returns:
    
    The map (keyed by client name) of master clients in this NOC design.
    
    Since:
    
    2022.1.0
  - getSlaveClients
```
public Map<String,NOCSlave> getSlaveClients()
```
    Gets the map of slave clients in the NOC design. The map is keyed by client name.
    
    Returns:
    
    The map (keyed by client name) of slave clients in this NOC design.
    
    Since:
    
    2022.1.0
  - setFrequency
```
public void setFrequency(int nocFrequency)
```
    Sets the target NOC frequency.
    
    Parameters:
    
    nocFrequency - The target NOC frequency to set.
    
    Since:
    
    2026.1.0
  - getFrequency
```
public int getFrequency()
```
    Gets the target frequency of this NOC design.
    
    Returns:
    
    The target frequency of this NOC design.
    
    Since:
    
    2022.1.0
  - areDestIDsLocked
```
public boolean areDestIDsLocked()
```
    Checks whether all destination IDs are locked.
    
    Returns:
    
    True if all destination IDs are locked, false otherwise.
    
    Since:
    
    2026.1.0
  - setAllDestIDsLocked
```
public void setAllDestIDsLocked(boolean lockAllDestIDs)
```
    Sets whether all destination IDs are locked.
    
    Parameters:
    
    lockAllDestIDs - True to lock all destination IDs, false otherwise.
    
    Since:
    
    2026.1.0
  - getSolutionType
```
public SolutionType getSolutionType()
```
    Gets the current NOC solution type.
    
    Returns:
    
    The current NOC solution type.
    
    Since:
    
    2026.1.0
  - setSolutionType
```
public void setSolutionType(SolutionType solutionType)
```
    Sets the current NOC solution type.
    
    Parameters:
    
    solutionType - The solution type to set.
    
    Since:
    
    2026.1.0
  - clearSolution
```
public void clearSolution()
```
    Clears the NOC solution if it exists.
    
    Since:
    
    2025.2.2
  - isRouted
```
public boolean isRouted()
```
    Checks if the NOC design is routed.
    
    Returns:
    
    True if the NOC design is routed, false otherwise.
    
    Since:
    
    2022.1.0
  - setIsRouted
```
public void setIsRouted(boolean isRouted)
```
    Sets whether this NOC design has routed solution data.
    
    Parameters:
    
    isRouted - True if the NOC design is routed, false otherwise.
    
    Since:
    
    2026.1.0
  - getDFXCells
```
public List<String> getDFXCells()
```
    Gets DFX cell paths in this NOC design.
    
    Returns:
    
    The DFX cell paths in this NOC design.
    
    Since:
    
    2026.1.0
  - copyClient
```
public NOCClient copyClient(NOCClient orig,
                            String name)
```
    Copy a client from another NOCDesign into this NOCDesign under a new name.
    
    Parameters:
    
    orig - The original NOC client to copy.
    
    name - The name for the copied client.
    
    Returns:
    
    The copied NOC client.
    
    Since:
    
    2026.1.0
  - addClient
```
public void addClient(NOCClient nc)
```
    Adds a NOC client to this design.
    
    Parameters:
    
    nc - The NOC client to add.
    
    Since:
    
    2026.1.0
  - removeClient
```
public void removeClient(String clientName)
```
    Removes a NOC client from this design by name.
    
    Parameters:
    
    clientName - The name of the client to remove.
    
    Since:
    
    2026.1.0
  - addConnection
```
public void addConnection(NOCConnection np)
```
    Adds a NOC connection to this design.
    
    Parameters:
    
    np - The NOC connection to add.
    
    Since:
    
    2026.1.0
  - removeConnection
```
public void removeConnection(NOCConnection np)
```
    Removes a NOC connection from this design.
    
    Parameters:
    
    np - The NOC connection to remove.
    
    Since:
    
    2026.1.0
  - getAllConnections
```
public List<NOCConnection> getAllConnections()
```
    Gets all the connections that are part of this NOC design.
    
    Returns:
    
    The list of all connections part of this NOC design.
    
    Since:
    
    2022.1.0
  - getClients
```
public Map<String,NOCClient> getClients()
```
    Gets all NOC clients part of this NOC design. The map is keyed by client name.
    
    Returns:
    
    A new map of all NOC clients part of this design. The map is keyed by client name.
    
    Since:
    
    2022.1.0
  - loadTraffic
```
public void loadTraffic(InputStream in)
```
    Loads NOC traffic data from a JSON input stream.
    
    Parameters:
    
    in - The input stream containing NOC traffic JSON data.
    
    Since:
    
    2026.1.0
  - loadSolution
```
public void loadSolution(InputStream in)
```
    Loads NOC solution data from a JSON input stream.
    
    Parameters:
    
    in - The input stream containing NOC solution JSON data.
    
    Since:
    
    2026.1.0
  - writeTraffic
```
public void writeTraffic(OutputStream out)
```
    Writes NOC traffic data to a JSON output stream.
    
    Parameters:
    
    out - The output stream to write NOC traffic JSON data to.
    
    Since:
    
    2026.1.0
  - writeSolution
```
public void writeSolution(OutputStream out)
```
    Writes NOC solution data to a JSON output stream.
    
    Parameters:
    
    out - The output stream to write NOC solution JSON data to.
    
    Since:
    
    2026.1.0

Class NOCDesign

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

NOCDesign

NOCDesign

Method Detail

setDesign

getDesign

getMasterClients

getSlaveClients

setFrequency

getFrequency

areDestIDsLocked

setAllDestIDsLocked

getSolutionType

setSolutionType

clearSolution

isRouted

setIsRouted

getDFXCells

copyClient

addClient

removeClient

addConnection

removeConnection

getAllConnections

getClients

loadTraffic

loadSolution

writeTraffic

writeSolution