com.xilinx.rapidwright.design.noc

Class NOCChannel

Object

com.xilinx.rapidwright.design.noc.NOCChannel

All Implemented Interfaces:

Serializable

public class NOCChannel
extends Object
implements Serializable

Represents the protocol and physical path of resources used to satisfy a protocol of a NOC Connection.

Since:

2022.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NOCChannel() Creates an empty NOC channel.
NOCChannel(org.json.JSONObject json) Creates a NOC channel from a JSON channel description.

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	getAllPhyInstances() Gets all physical instances used by this channel path.
List<String>	getChannelPath() Gets the list of switches used to connect this NOC Channel
ChannelType	getChannelType() Gets this channel's type
int	getEstimatedBandwidth() Gets the estimated bandwidth expected for this channel (MB/s)
int	getEstimatedLatency() Gets the estimated latency achieved on this channel (in cycles)
int	getRequiredBandwidth() Gets this channel's required bandwidth (in MB/s)
int	getRequiredLatency() Gets the latency constraint on this channel (in cycles)
int	getVc() Gets the virtual channel index.
void	setChannelPath(ArrayList<String> channelPath) Sets the list of switches used to connect this NOC Channel
void	setChannelType(ChannelType channel) Sets this channel's type
void	setEstimatedBandwidth(int estimatedBandwidth) Sets the estimated bandwidth expected for this channel (in MB/s)
void	setEstimatedLatency(int estimatedLatency) Sets the estimated latency achieved on this channel in cycles.
void	setRequiredBandwidth(int requiredBandwidth) Sets this channel's required bandwidth (in MB/s)
void	setRequiredLatency(int requiredLatency) Sets the required latency for this channel in cycles.
void	setVc(int vc) Sets the virtual channel index.
org.json.JSONObject	toJSONObject() Converts this channel to its JSON representation.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NOCChannel

public NOCChannel()

Creates an empty NOC channel.

Since:

2026.1.0

NOCChannel

public NOCChannel(org.json.JSONObject json)

Creates a NOC channel from a JSON channel description.

Parameters:

json - The JSON channel description.

Since:

2026.1.0

Method Detail

getChannelPath

public List<String> getChannelPath()

Gets the list of switches used to connect this NOC Channel

Returns:

The list of switches used in this channel

Since:

2022.1.0

setChannelPath

public void setChannelPath(ArrayList<String> channelPath)

Sets the list of switches used to connect this NOC Channel

Parameters:

channelPath -

Since:

2026.1.0

getChannelType

public ChannelType getChannelType()

Gets this channel's type

Returns:

This channel's type

Since:

2022.1.0

setChannelType

public void setChannelType(ChannelType channel)

Sets this channel's type

Parameters:

channel - The new channel type to set

Since:

2026.1.0

getVc

public int getVc()

Gets the virtual channel index.

Returns:

The virtual channel index.

Since:

2026.1.0

setVc

public void setVc(int vc)

Sets the virtual channel index.

Parameters:

vc - The virtual channel index to set.

Since:

2026.1.0

getRequiredBandwidth

public int getRequiredBandwidth()

Gets this channel's required bandwidth (in MB/s)

Returns:

The channel's required bandwidth in MB/s

Since:

2022.1.0

setRequiredBandwidth

public void setRequiredBandwidth(int requiredBandwidth)

Sets this channel's required bandwidth (in MB/s)

Parameters:

requiredBandwidth - Channel's required bandwidth (in MB/s)

Since:

2026.1.0

getEstimatedBandwidth

public int getEstimatedBandwidth()

Gets the estimated bandwidth expected for this channel (MB/s)

Returns:

The estimated channel bandwidth in MB/s

Since:

2022.1.0

setEstimatedBandwidth

public void setEstimatedBandwidth(int estimatedBandwidth)

Sets the estimated bandwidth expected for this channel (in MB/s)

Parameters:

estimatedBandwidth -

Since:

2026.1.0

getRequiredLatency

public int getRequiredLatency()

Gets the latency constraint on this channel (in cycles)

Returns:

The latency constraint on this channel in cycles

Since:

2022.1.0

setRequiredLatency

public void setRequiredLatency(int requiredLatency)

Sets the required latency for this channel in cycles.

Parameters:

requiredLatency - The required latency in cycles.

Since:

2026.1.0

getEstimatedLatency

public int getEstimatedLatency()

Gets the estimated latency achieved on this channel (in cycles)

Returns:

The estimated latency achieved on this channel in cycles

Since:

2022.1.0

setEstimatedLatency

public void setEstimatedLatency(int estimatedLatency)

Sets the estimated latency achieved on this channel in cycles.

Parameters:

estimatedLatency - The estimated latency in cycles.

Since:

2026.1.0

getAllPhyInstances

public ArrayList<String> getAllPhyInstances()

Gets all physical instances used by this channel path.

Returns:

The physical instance names used by this channel path.

Since:

2026.1.0

toJSONObject

public org.json.JSONObject toJSONObject()

Converts this channel to its JSON representation.

Returns:

The JSON representation of this channel.

Since:

2026.1.0