NOCClient

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NOCMaster, NOCSlave
```
public class NOCClient
extends Object
implements Serializable
```
Represents a NOC client endpoint within a NOCDesign or NOC solution.

Since:

2022.1.0

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`NOCClient()` Creates an empty NOC client.
`NOCClient(org.json.JSONObject json)` Creates a NOC client from a JSON client description.
`NOCClient(NOCClient nc)` Creates a copy of an existing NOC client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnection(NOCConnection np)` Adds a connection associated with this NOC client.
`void`	`addExternalConnection(String s)` Adds an external connection name for this client.
`void`	`checkUnsupportedFields(org.json.JSONObject json)` Checks whether a JSON client description contains fields that are not supported.
`int`	`getAxiDataWidth()` Gets the AXI data width for this client.
`ComponentType`	`getComponentType()` Gets the component type of this client
`List<NOCConnection>`	`getConnections()` Gets the connections associated with this NOC client
`int`	`getDestID()` Gets the destination ID for this client.
`List<String>`	`getExternalConnections()` Gets external connection names for this client.
`String`	`getLocation()` Gets the name of the location (site) of this client
`String`	`getName()` Gets the name of this client
`ProtocolType`	`getProtocol()` Gets the protocol type of this client
`Map<String,String>`	`getSimMetaData()` Gets simulation metadata for this client.
`boolean`	`hasParityAddr()` Checks whether this client has address parity.
`boolean`	`hasParityData()` Checks whether this client has data parity.
`boolean`	`isDDRC()` Checks if this client is a DDR memory client
`boolean`	`isFabricClient()` Checks if this client is located in the programmable logic fabric.
`boolean`	`isVirtual()` Checks whether this client is virtual.
`void`	`removeConnection(NOCConnection np)` Removes a connection associated with this NOC client.
`void`	`setAxiDataWidth(int axiDataWidth)` Sets the AXI data width for this client.
`void`	`setComponentType(ComponentType compType)` Sets the component type of this client.
`void`	`setDestID(int destID)` Sets the destination ID for this client.
`void`	`setLocation(String location)` Sets the location of the client
`void`	`setName(String name)` Sets the name of this client.
`void`	`setParityAddr(boolean hasParityAddr)` Sets whether this client has address parity.
`void`	`setParityData(boolean hasParityData)` Sets whether this client has data parity.
`void`	`setProtocol(ProtocolType protocol)` Sets the protocol type of this client.
`void`	`setVirtual(boolean isVirtual)` Sets whether this client is virtual.
`org.json.JSONObject`	`toJSONObject()` Converts this client to its JSON representation.
`String`	`toString()` Gets the String representation of this client

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

- Constructor Detail
  - NOCClient
```
public NOCClient()
```
    Creates an empty NOC client.
    
    Since:
    
    2026.1.0
  - NOCClient
```
public NOCClient(NOCClient nc)
```
    Creates a copy of an existing NOC client.
    
    Parameters:
    
    nc - The NOC client to copy.
    
    Since:
    
    2026.1.0
  - NOCClient
```
public NOCClient(org.json.JSONObject json)
```
    Creates a NOC client from a JSON client description.
    
    Parameters:
    
    json - The JSON client description.
    
    Since:
    
    2026.1.0
- Method Detail
  - checkUnsupportedFields
```
public void checkUnsupportedFields(org.json.JSONObject json)
```
    Checks whether a JSON client description contains fields that are not supported.
    
    Parameters:
    
    json - The JSON client description to check.
    
    Since:
    
    2026.1.0
  - toJSONObject
```
public org.json.JSONObject toJSONObject()
```
    Converts this client to its JSON representation.
    
    Returns:
    
    The JSON representation of this client.
    
    Since:
    
    2026.1.0
  - isFabricClient
```
public boolean isFabricClient()
```
    Checks if this client is located in the programmable logic fabric.
    
    Returns:
    
    True if this client is located in the programmable logic fabric, false otherwise.
    
    Since:
    
    2022.1.0
  - addConnection
```
public void addConnection(NOCConnection np)
```
    Adds a connection associated with this NOC client.
    
    Parameters:
    
    np - The connection to add.
    
    Since:
    
    2026.1.0
  - getConnections
```
public List<NOCConnection> getConnections()
```
    Gets the connections associated with this NOC client
    
    Returns:
    
    The list of connections associated with this NOC client
    
    Since:
    
    2022.1.0
  - removeConnection
```
public void removeConnection(NOCConnection np)
```
    Removes a connection associated with this NOC client.
    
    Parameters:
    
    np - The connection to remove.
    
    Since:
    
    2026.1.0
  - setLocation
```
public void setLocation(String location)
```
    Sets the location of the client
    
    Parameters:
    
    location - The site of the client to set
    
    Since:
    
    2022.1.0
  - getLocation
```
public String getLocation()
```
    Gets the name of the location (site) of this client
    
    Returns:
    
    The name of the location (site) of this client
    
    Since:
    
    2022.1.0
  - setDestID
```
public void setDestID(int destID)
```
    Sets the destination ID for this client.
    
    Parameters:
    
    destID - The destination ID to set.
    
    Since:
    
    2026.1.0
  - getDestID
```
public int getDestID()
```
    Gets the destination ID for this client.
    
    Returns:
    
    The destination ID for this client.
    
    Since:
    
    2026.1.0
  - getName
```
public String getName()
```
    Gets the name of this client
    
    Returns:
    
    The name of this client
    
    Since:
    
    2022.1.0
  - isDDRC
```
public boolean isDDRC()
```
    Checks if this client is a DDR memory client
    
    Returns:
    
    True if this is a DDR memory client, false otherwise.
    
    Since:
    
    2022.1.0
  - setName
```
public void setName(String name)
```
    Sets the name of this client.
    
    Parameters:
    
    name - The client name to set.
    
    Since:
    
    2026.1.0
  - getExternalConnections
```
public List<String> getExternalConnections()
```
    Gets external connection names for this client.
    
    Returns:
    
    The external connection names for this client.
    
    Since:
    
    2026.1.0
  - addExternalConnection
```
public void addExternalConnection(String s)
```
    Adds an external connection name for this client.
    
    Parameters:
    
    s - The external connection name to add.
    
    Since:
    
    2026.1.0
  - setParityAddr
```
public void setParityAddr(boolean hasParityAddr)
```
    Sets whether this client has address parity.
    
    Parameters:
    
    hasParityAddr - True if this client has address parity, false otherwise.
    
    Since:
    
    2026.1.0
  - hasParityAddr
```
public boolean hasParityAddr()
```
    Checks whether this client has address parity.
    
    Returns:
    
    True if this client has address parity, false otherwise.
    
    Since:
    
    2026.1.0
  - setParityData
```
public void setParityData(boolean hasParityData)
```
    Sets whether this client has data parity.
    
    Parameters:
    
    hasParityData - True if this client has data parity, false otherwise.
    
    Since:
    
    2026.1.0
  - hasParityData
```
public boolean hasParityData()
```
    Checks whether this client has data parity.
    
    Returns:
    
    True if this client has data parity, false otherwise.
    
    Since:
    
    2026.1.0
  - setVirtual
```
public void setVirtual(boolean isVirtual)
```
    Sets whether this client is virtual.
    
    Parameters:
    
    isVirtual - True if this client is virtual, false otherwise.
    
    Since:
    
    2026.1.0
  - isVirtual
```
public boolean isVirtual()
```
    Checks whether this client is virtual.
    
    Returns:
    
    True if this client is virtual, false otherwise.
    
    Since:
    
    2026.1.0
  - setAxiDataWidth
```
public void setAxiDataWidth(int axiDataWidth)
```
    Sets the AXI data width for this client.
    
    Parameters:
    
    axiDataWidth - The AXI data width to set.
    
    Since:
    
    2026.1.0
  - getAxiDataWidth
```
public int getAxiDataWidth()
```
    Gets the AXI data width for this client.
    
    Returns:
    
    The AXI data width for this client.
    
    Since:
    
    2026.1.0
  - setComponentType
```
public void setComponentType(ComponentType compType)
```
    Sets the component type of this client.
    
    Parameters:
    
    compType - The component type to set.
    
    Since:
    
    2026.1.0
  - getComponentType
```
public ComponentType getComponentType()
```
    Gets the component type of this client
    
    Returns:
    
    the component type of this client
    
    Since:
    
    2022.1.0
  - setProtocol
```
public void setProtocol(ProtocolType protocol)
```
    Sets the protocol type of this client.
    
    Parameters:
    
    protocol - The protocol type to set.
    
    Since:
    
    2026.1.0
  - getProtocol
```
public ProtocolType getProtocol()
```
    Gets the protocol type of this client
    
    Returns:
    
    the protocol type of this client
    
    Since:
    
    2022.1.0
  - getSimMetaData
```
public Map<String,String> getSimMetaData()
```
    Gets simulation metadata for this client.
    
    Returns:
    
    The simulation metadata for this client.
    
    Since:
    
    2026.1.0
  - toString
```
public String toString()
```
    Gets the String representation of this client
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The String representation of this client, 'name + (componentType)'
    
    Since:
    
    2022.1.0

Class NOCClient

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

NOCClient

NOCClient

NOCClient

Method Detail

checkUnsupportedFields

toJSONObject

isFabricClient

addConnection

getConnections

removeConnection

setLocation

getLocation

setDestID

getDestID

getName

isDDRC

setName

getExternalConnections

addExternalConnection

setParityAddr

hasParityAddr

setParityData

hasParityData

setVirtual

isVirtual

setAxiDataWidth

getAxiDataWidth

setComponentType

getComponentType

setProtocol

getProtocol

getSimMetaData

toString