JRBExport: Exporting rbmatlab models for the JRB project. More...

Detailed Description

JRBExport: Exporting rbmatlab models for the JRB project.

Exports rbmatlab models to a specific folder.

The models can be exported in two formats, either for the JRB project (and thus JaRMoS) or for the rbappmit-Android app.

Author: Daniel Wirtz

Date: 2011-08-26

Initial code for rbappmit-format export by Markus Dihlmann, 21.08.2011

Definition at line 17 of file JRBExport.m.

Public Member Functions
function	export_file (matfile)
	Exports an m-file containing rb data to a model. More...

function	export (model, det)
	Exports the given model using the detailed data. More...

Public Member Functions inherited from JaRMoSExport
function	exportModel (models.ReducedModel model,char folder)
	Exports the given model for use in JaRMoS to the given folder. More...

Public Attributes
	Version = 0
	The model export version to use. Can be either 0 for for JRB models or 1 for rbappmit-models. More...

	TargetFolder = "/home/dwirtz/aghwww/romsim/rbm_advec"
	The folder to write the model data to. More...

	JRBSource = "/home/dwirtz/aghhome/Software/Eclipse/JRB/src"
	The source of the JRB software. More...

	Params = "[]"
	Some additional export parameters. More...

	AffFcnsJava = ""
	Path to the AffineFunctions file giving the \(\theta_i\) coefficient functions. More...

	ForWebFolder = true
	Flag that indicates if the export is for a web folder. More...

Public Attributes inherited from JaRMoSExport
integer	DoFFields = 0
	The number of degrees of freedom-fields this system computes as output. More...

struct	LogicalFields = "[]"
	Returns the field descriptions for each logical solution field. More...

function_handle	GeometryExportCallback = "[]"
	A callback for geometry export of the JaRMoS-Model. More...

char	JavaExportPackage = ""
	The package of any java classes associated with this model when exported to JaRMoS. More...

char	JaRMoSBaseSource = ""
	The JaRMoSBase java sources directory. Required if any java classes are to by compiled. More...

char	ModelType = "Unknown"
	The model type according to the jarmos.ModelType enum. More...

char	Short = ""
	Short description for the model. More...

Public Attributes inherited from handle
	addlistener
	Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...

	notify
	Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...

	delete
	Handle object destructor method that is called when the object's lifecycle ends. More...

	disp
	Handle object disp method which is called by the display method. See the MATLAB disp function. More...

	display
	Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...

	findobj
	Finds objects matching the specified conditions from the input array of handle objects. More...

	findprop
	Returns a meta.property objects associated with the specified property name. More...

	fields
	Returns a cell array of string containing the names of public properties. More...

	fieldnames
	Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...

	isvalid
	Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...

	eq
	Relational functions example. See details for more information. More...

	transpose
	Transposes the elements of the handle object array. More...

	permute
	Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...

	reshape
	hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...

	sort
	ort the handle objects in any array in ascending or descending order. More...

Additional Inherited Members
Protected Member Functions inherited from JaRMoSExport
virtual function [ sourcebase , sourcefiles ] =	typeSpecificExport (f,models.BaseFullModel model, settings, folder)

Member Function Documentation

function JRBExport.export	(	model,
		det
	)

Exports the given model using the detailed data.

Parameters

model	The model struct of rbmatlab
det	the model`s detailed data (`detailed_data')

Required fields of model:

Definition at line 157 of file JRBExport.m.

References ForWebFolder, TargetFolder, and Version.

Referenced by export_file().

Here is the caller graph for this function:

function JRBExport.export_file ( matfile )

Exports an m-file containing rb data to a model.

Parameters

matfile The name of the mat-file. Must contain the structs model and detailed_data

Definition at line 144 of file JRBExport.m.

References export().

Here is the call graph for this function:

Member Data Documentation

JRBExport.AffFcnsJava = ""

Path to the AffineFunctions file giving the \(\theta_i\) coefficient functions.

When using the version jrb (default), leave this field empty in order for the ModelExport to search within the JRB sources for the appropriate AffineFunctions class. There, the package named "models.<modelfolder>" package is searched for the file, where <modelfolder> is the folder name gained by using fileparts on the TargetFolder string.

Default: '

Definition at line 78 of file JRBExport.m.

JRBExport.ForWebFolder = true

Flag that indicates if the export is for a web folder.

If true, a file models.txt in the parent folder is searched and opened, and the model directory name added to the list if not already in it. If no such file exists, an attempt is made to create it.

If false, no further actions are taken.

Default: true

Definition at line 93 of file JRBExport.m.

Referenced by export().

JRBExport.JRBSource = "/home/dwirtz/aghhome/Software/Eclipse/JRB/src"

The source of the JRB software.

Default: "/home/dwirtz/aghhome/Software/Eclipse/JRB/src"

Definition at line 57 of file JRBExport.m.

JRBExport.Params = "[]"

Some additional export parameters.

For JRB models the only the model_type and title fields are considered if given, otherwise autodetection is tried.

Default: "[]"

Definition at line 66 of file JRBExport.m.

JRBExport.TargetFolder = "/home/dwirtz/aghwww/romsim/rbm_advec"

The folder to write the model data to.

Default: "/home/dwirtz/aghwww/romsim/rbm_advec"

Note: This property has custom functionality when its value is changed.

Definition at line 48 of file JRBExport.m.

Referenced by export().

JRBExport.Version = 0

The model export version to use. Can be either 0 for for JRB models or 1 for rbappmit-models.

Default: 0

Note: This property has custom functionality when its value is changed.

Definition at line 37 of file JRBExport.m.

Referenced by export().

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

matlabtojarmos/JRBExport.m

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation