hades.utils.vhdl
Interface VHDLExportable

public interface VHDLExportable

tagging interface to signal VHDL export capability.

VHDLExportable - a tagging interface to be implemented by all HADES SimObjects that can be exported to VHDL format. This interface provides for separate functions to write the SimObject's entity declaration, architecture, configuration, and packages. All of these methods are declared to throw an Exception to allow for specific and useful error messages.

Method Summary

void	writeArchitecture(java.io.PrintWriter PW) write a VHDL 93 compatible architecture description for this HADES SimObject.
void	writeConfiguration(java.io.PrintWriter PW) write a VHDL 93 compatible (default) configuration for this HADES SimObject.
void	writeEntity(java.io.PrintWriter PW) write a VHDL 93 compatible entity declaration for this HADES SimObject
void	writePackageBody(java.io.PrintWriter PW)
void	writePackageDeclaration(java.io.PrintWriter PW) write a VHDL 93 compatible package description needed for this HADES SimObject.

Method Detail

writeEntity

public void writeEntity(java.io.PrintWriter PW)
                 throws java.lang.Exception

write a VHDL 93 compatible entity declaration for this HADES SimObject

Throws:

java.lang.Exception

writeArchitecture

public void writeArchitecture(java.io.PrintWriter PW)
                       throws java.lang.Exception

write a VHDL 93 compatible architecture description for this HADES SimObject. This might be either a behavioural or a netlist architecture.

Throws:

java.lang.Exception

writeConfiguration

public void writeConfiguration(java.io.PrintWriter PW)
                        throws java.lang.Exception

write a VHDL 93 compatible (default) configuration for this HADES SimObject.

Throws:

java.lang.Exception

writePackageDeclaration

public void writePackageDeclaration(java.io.PrintWriter PW)
                             throws java.lang.Exception

write a VHDL 93 compatible package description needed for this HADES SimObject. Note that this method will do nothing for most SimObjects, because no special utility package is needed.

Throws:

java.lang.Exception

writePackageBody

public void writePackageBody(java.io.PrintWriter PW)
                      throws java.lang.Exception

Throws:

java.lang.Exception