com.cmpware.cmp
Class Link

java.lang.Object
  com.cmpware.cmp.Link

All Implemented Interfaces:

MemoryMappedIOReader, MemoryMappedIOWriter

Direct Known Subclasses:

BroadcastBus, FIFO, PipelineRegister, SharedRegister

public abstract class Link
extends java.lang.Object
implements MemoryMappedIOReader, MemoryMappedIOWriter

This abstarct class defines a Link. This is just an object that implements both the Memory Mapped IO Reader and Memory Mapped IO Writer. This is provided primarily as a convenience.

Copyright (c) 2004 Cmpware, Inc. All Rights Reserved.

Author:

SAG

Field Summary

Fields inherited from interface com.cmpware.cmp.mmio.MemoryMappedIOReader

copyright

Fields inherited from interface com.cmpware.cmp.mmio.MemoryMappedIOWriter

copyright

Constructor Summary

Link()

Method Summary

static Link	get(java.lang.String linkName) This static method is used to return a newly allocated Link object from the link name string.
void	setBufferSize(int size) This method is used to set the buffer size in the communication link.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.cmpware.cmp.mmio.MemoryMappedIOReader

getReadAddress, getReadCount, getReadStallCount, getValue, isReadable, read, readCommit, reset, setReadAddress

Methods inherited from interface com.cmpware.cmp.mmio.MemoryMappedIOWriter

getValue, getWriteAddress, getWriteCount, getWriteStallCount, isWriteable, reset, setWriteAddress, write, writeCommit

Constructor Detail

Link

public Link()

Method Detail

setBufferSize

public void setBufferSize(int size)

This method is used to set the buffer size in the communication link. The method defined here does nothing. If the subclass of Link needs the ability to set a buffer size, it should overload this method.

Parameters:

size - The buffer size.

get

public static Link get(java.lang.String linkName)
                throws LinkException

This static method is used to return a newly allocated Link object from the link name string.

Parameters:

linkName - The name of the link. This is the class name of the Link class file under com.cmpware.cmp.links.

Returns:

This method returns a newly created Link object from the link name string.

Throws:

LinkException - if any problems we encountered allocating the new Link object.