Collaboration diagram for m2m.backend.project.M2MProject:

Public Member Functions
String	subfolder ()
boolean	isModified ()
void	setModified (boolean modified)
SimulationResult	getSimulationResult ()
void	setSimulationResult (SimulationResult simResult)
void	setLastMonitoring (boolean monitor)
boolean	openProject (String fileName)
boolean	CreateEmptyProject (String fileName)
boolean	CreateNewProjectFromMath (String fileName, String fileNameOctave)
	M2MProject ()
boolean	getUseFifo ()
void	setUseFifo (boolean bool)
OptimisationProperties	getOptimisationProperties ()
SimulationProperties	getSimulationProperties ()
File	getSourceFile ()
String	getProjectFilename ()
String	getVHDLPath ()
String	getVHDLSubFolder ()
String	getUbidulePath ()
String	getSVPath ()
String	getOctavePath ()
String	getReportPath ()
String	getSimPath ()
String	getIOFilesPath ()
String	getCompPath ()
String	getSourcePath ()
ProjectProperties	getProperties ()
String	getSourceFilePath ()
void	setProperties (ProjectProperties properties)
void	setFile (File file)
boolean	compare (M2MProject project)
boolean	checkFolders ()
void	clear ()
boolean	generateVHDL ()
StructTreatment	getStructTreatment ()
void	clearStructTreatment ()
boolean	compareOctaveResult ()
boolean	reGenerateOctave ()
boolean	generateFlatDotFile ()
boolean	generateTreeDotFile ()
boolean	generateCopyTreeDotFile ()
boolean	launchDotGeneration ()
boolean	optimize ()
boolean	save ()
boolean	saveFile (File f)
boolean	compatibleVersion (String version1, String version2)
boolean	loadFile (File f)
void	restoreOctave ()
boolean	sourceFileExist ()
boolean	checkSourceFile ()
String	getXmlTagName ()
boolean	fromXml (Element el)
Element	toXml (Document dom)
boolean	isUbiduleFilesUpToDate ()
boolean	isOctaveUpToDate ()
boolean	isVHDLUpToDate ()
Static Public Member Functions
static String	getLibPath ()
static String	getUbiduleDirName ()
static String	getVHDLDirName ()
static String	getSVDirName ()
static String	getOctaveDirName ()
static String	getReportDirName ()
static String	getSimDirName ()
static String	getIOFilesDirName ()
static String	getCompDirName ()
static String	getSourceDirName ()
static boolean	checkFolders (String basePath)
Public Attributes
ProgressMonitoring	monitoring
Static Public Attributes
static final String	CURRENTVERSION = "0.5.0"

Detailed Description

Definition at line 54 of file M2MProject.java.

Constructor & Destructor Documentation

m2m.backend.project.M2MProject.M2MProject ( )

Definition at line 287 of file M2MProject.java.

Member Function Documentation

boolean m2m.backend.project.M2MProject.checkFolders ( )

Checks if the project folders exist, and if not create them. The folders are the ones for VHDL, SV, Octave, Compilation, and report. This function is provided for convenience.

Returns:: True if the folders exist or are created correcty, false otherwise.

Definition at line 616 of file M2MProject.java.

static boolean m2m.backend.project.M2MProject.checkFolders ( String basePath ) [static]

Checks if the project folders exist, and if not create them. The folders are the ones for VHDL, SV, Octave, Compilation, and report.

Parameters:

basePath base dcirectory of the project

Returns:: True if the folders exist or are created correcty, false otherwise.

Definition at line 626 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.checkSourceFile ( )

Definition at line 1043 of file M2MProject.java.

void m2m.backend.project.M2MProject.clear ( )

Definition at line 696 of file M2MProject.java.

void m2m.backend.project.M2MProject.clearStructTreatment ( )

Clear the structTreatment.

Definition at line 770 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.compare ( M2MProject project )

Compare two projects.

Parameters:

project The project to compare with the current.

Returns:: True if the two projects are identical. False otherwise.

Definition at line 606 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.compareOctaveResult ( )

Definition at line 774 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.compatibleVersion	(	String	version1,
		String	version2
	)

Definition at line 958 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.CreateEmptyProject ( String fileName )

Definition at line 219 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.CreateNewProjectFromMath	(	String	fileName,
		String	fileNameOctave
	)

Definition at line 263 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.fromXml ( Element el )

Definition at line 1069 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.generateCopyTreeDotFile ( )

Definition at line 849 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.generateFlatDotFile ( )

Definition at line 816 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.generateTreeDotFile ( )

Definition at line 828 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.generateVHDL ( )

Definition at line 744 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getCompDirName ( ) [static]

Get the name of the subfolder containing the compilation files

Returns:: The name of the subfolder containing the compilation files

Definition at line 534 of file M2MProject.java.

String m2m.backend.project.M2MProject.getCompPath ( )

Get the directory path of the compilation files

Returns:: the directory path of the compilation files

Definition at line 542 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getIOFilesDirName ( ) [static]

Get the name of the subfolder containing the IO files

Returns:: The name of the subfolder containing IO files

Definition at line 518 of file M2MProject.java.

String m2m.backend.project.M2MProject.getIOFilesPath ( )

Get the directory path of the IO files

Returns:: the directory path of the IO files

Definition at line 526 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getLibPath ( ) [static]

Definition at line 117 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getOctaveDirName ( ) [static]

Get the name of the subfolder containing the octave files

Returns:: The name of the subfolder containing the octave files

Definition at line 469 of file M2MProject.java.

String m2m.backend.project.M2MProject.getOctavePath ( )

Get the directory path of the octave files

Returns:: the directory path of the octave files

Definition at line 477 of file M2MProject.java.

OptimisationProperties m2m.backend.project.M2MProject.getOptimisationProperties ( )

Get all the properties relative to the optimisation.

Returns:: The optimisation properties.

Definition at line 367 of file M2MProject.java.

String m2m.backend.project.M2MProject.getProjectFilename ( )

Get the input file used to created the instance of M2MProject.

Returns:: The path to the input file.

Definition at line 411 of file M2MProject.java.

ProjectProperties m2m.backend.project.M2MProject.getProperties ( )

Get all the project properties.

Returns:: The project properties.

Definition at line 567 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getReportDirName ( ) [static]

Get the name of the subfolder containing the report files

Returns:: The name of the subfolder containing the report files

Definition at line 485 of file M2MProject.java.

String m2m.backend.project.M2MProject.getReportPath ( )

Get the directory path of the report files

Returns:: the directory path of the report files

Definition at line 493 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getSimDirName ( ) [static]

Get the name of the subfolder containing the simulation files

Returns:: The name of the subfolder containing the simulation files

Definition at line 502 of file M2MProject.java.

String m2m.backend.project.M2MProject.getSimPath ( )

Get the directory path of the simulation files

Returns:: the directory path of the simulation files

Definition at line 510 of file M2MProject.java.

SimulationProperties m2m.backend.project.M2MProject.getSimulationProperties ( )

Get all properties relative to the simulation.

Returns:: The simulation properties.

Definition at line 376 of file M2MProject.java.

SimulationResult m2m.backend.project.M2MProject.getSimulationResult ( )

Returns:: the simResult

Definition at line 100 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getSourceDirName ( ) [static]

Get the name of the subfolder containing the source file

Returns:: The name of the subfolder containing the source file

Definition at line 550 of file M2MProject.java.

File m2m.backend.project.M2MProject.getSourceFile ( )

Get the source file. The source file is the input file if the file loaded is not a Math2Mat project.

Returns:: The source file.

Definition at line 386 of file M2MProject.java.

String m2m.backend.project.M2MProject.getSourceFilePath ( )

Get the source file path.

Returns:: The source file path.

Definition at line 576 of file M2MProject.java.

String m2m.backend.project.M2MProject.getSourcePath ( )

Get the directory path of the source file

Returns:: the directory path of the source file

Definition at line 558 of file M2MProject.java.

StructTreatment m2m.backend.project.M2MProject.getStructTreatment ( )

Get the strucTreatment corresponding to the project.

Returns:: Project's structTreatment.

Definition at line 762 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getSVDirName ( ) [static]

Get the name of the subfolder containing the SystemVerilog files

Returns:: The name of the subfolder containing the SystemVerilog files

Definition at line 453 of file M2MProject.java.

String m2m.backend.project.M2MProject.getSVPath ( )

Get the directory path of the SystemVerilog files

Returns:: the directory path of the SystemVerilog files

Definition at line 461 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getUbiduleDirName ( ) [static]

Definition at line 416 of file M2MProject.java.

String m2m.backend.project.M2MProject.getUbidulePath ( )

Get the directory path of the ubidule files

Returns:: the directory path of the ubidule files

Definition at line 445 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.getUseFifo ( )

This constructor make or get informations about the project. If a project is loaded (*.m2m file), it gets all the information about it, otherwise it creates new blank instance of properties. The properties are saved in the M2MProject's instance when modified.

Parameters:

file	File used to create the project, a m2m project file (.m2m) or a source file (.m). Get the useFifo attribute of the project.

Returns:: the useFifo attribute of the project

Definition at line 347 of file M2MProject.java.

static String m2m.backend.project.M2MProject.getVHDLDirName ( ) [static]

Get the name of the subfolder containing the VHDL files

Returns:: The name of the subfolder containing the VHDL files

Definition at line 424 of file M2MProject.java.

String m2m.backend.project.M2MProject.getVHDLPath ( )

Get the directory path of the VHDL files

Returns:: the directory path of the VHDL files

Definition at line 432 of file M2MProject.java.

String m2m.backend.project.M2MProject.getVHDLSubFolder ( )

Definition at line 436 of file M2MProject.java.

String m2m.backend.project.M2MProject.getXmlTagName ( )

Definition at line 1065 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.isModified ( )

Returns:: the modified

Definition at line 84 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.isOctaveUpToDate ( )

Definition at line 1108 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.isUbiduleFilesUpToDate ( )

Definition at line 1099 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.isVHDLUpToDate ( )

Definition at line 1120 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.launchDotGeneration ( )

Definition at line 867 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.loadFile ( File f )

Definition at line 981 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.openProject ( String fileName )

Definition at line 192 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.optimize ( )

Definition at line 873 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.reGenerateOctave ( )

Definition at line 793 of file M2MProject.java.

void m2m.backend.project.M2MProject.restoreOctave ( )

Definition at line 1022 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.save ( )

Definition at line 881 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.saveFile ( File f )

Definition at line 895 of file M2MProject.java.

void m2m.backend.project.M2MProject.setFile ( File file )

Set the input file.

Parameters:

file	Input file.

Definition at line 595 of file M2MProject.java.

void m2m.backend.project.M2MProject.setLastMonitoring ( boolean monitor )

Definition at line 111 of file M2MProject.java.

void m2m.backend.project.M2MProject.setModified ( boolean modified )

Parameters:

modified the modified to set

Definition at line 91 of file M2MProject.java.

void m2m.backend.project.M2MProject.setProperties ( ProjectProperties properties )

Set all the project properties.

Parameters:

properties The properties to set.

Definition at line 586 of file M2MProject.java.

void m2m.backend.project.M2MProject.setSimulationResult ( SimulationResult simResult )

Parameters:

simResult the simResult to set

Definition at line 107 of file M2MProject.java.

void m2m.backend.project.M2MProject.setUseFifo ( boolean bool )

Update the boolean that tells if the VHDL design needs fifo.

Parameters:

bool	Value to set.

Definition at line 357 of file M2MProject.java.

boolean m2m.backend.project.M2MProject.sourceFileExist ( )

Definition at line 1034 of file M2MProject.java.

String m2m.backend.project.M2MProject.subfolder ( )

Definition at line 58 of file M2MProject.java.

Element m2m.backend.project.M2MProject.toXml ( Document dom )

Definition at line 1087 of file M2MProject.java.

Member Data Documentation

final String m2m.backend.project.M2MProject.CURRENTVERSION = "0.5.0" [static]

Definition at line 56 of file M2MProject.java.

ProgressMonitoring m2m.backend.project.M2MProject.monitoring

Definition at line 62 of file M2MProject.java.

The documentation for this class was generated from the following file:

/home/ythoma/docs/math2mat/svn/wp1/framework/m2mGUI/src/m2m/backend/project/M2MProject.java

m2m.backend.project.M2MProject Class Reference

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation