m2m.backend.structure.LoopFor Class Reference

Inheritance diagram for m2m.backend.structure.LoopFor:

Collaboration diagram for m2m.backend.structure.LoopFor:

List of all members.

Public Member Functions
String	getXmlTagName ()
boolean	insideFromXml (org.w3c.dom.Element el, Function newFunc)
void	insideToXml (org.w3c.dom.Element el, Document dom, boolean shortRef)
	LoopFor ()
Element	copy (Function newFunc)
void	setStart (SimpleVariable start)
SimpleVariable	getStart ()
void	setIncr (SimpleVariable incr)
SimpleVariable	getIncr ()
void	setEnd (SimpleVariable end)
SimpleVariable	getEnd ()
void	setLoopVariables (Vector< SimpleVariable > vector)
Vector< SimpleVariable >	getLoopVariables ()
void	setIterOperation (Operation op)
Operation	getIterOperation ()
String	toString (int level)
String	toSchematic (int level, String prefix, String boxFormat, String color)
String	toOctave (int level)
SimpleVariable	getLoopVariable (SimpleVariable var)
SimpleVariable	getInitVariable (SimpleVariable var)

---

Detailed Description

Describe a loop.

Author:

Trolliet Gregory

gregory.trolliet@hesge.ch

Version:

0.1

Definition at line 22 of file LoopFor.java.

---

Constructor & Destructor Documentation

m2m.backend.structure.LoopFor.LoopFor

(

)

Construct an empty loop (1:1:1)

Definition at line 136 of file LoopFor.java.

---

Member Function Documentation

Element m2m.backend.structure.LoopFor.copy

(

Function

newFunc

)

[virtual]

Copy entirely the for loop.

Returns:

The new for loop.

Reimplemented from m2m.backend.structure.Function.

Definition at line 149 of file LoopFor.java.

SimpleVariable m2m.backend.structure.LoopFor.getEnd

(

)

Getter for end

Returns:

End

Definition at line 202 of file LoopFor.java.

SimpleVariable m2m.backend.structure.LoopFor.getIncr

(

)

Getter for increment

Returns:

Increment

Definition at line 186 of file LoopFor.java.

SimpleVariable m2m.backend.structure.LoopFor.getInitVariable

(

SimpleVariable

var

)

Get the init variable if the parameter is a loop output variable.

Parameters:

var	the loop output variable

Returns:

the init variable

Definition at line 343 of file LoopFor.java.

Operation m2m.backend.structure.LoopFor.getIterOperation

(

)

Get the iterator operation of the loop for.

Returns:

the iterator operation of the loop for

Definition at line 234 of file LoopFor.java.

SimpleVariable m2m.backend.structure.LoopFor.getLoopVariable

(

SimpleVariable

var

)

Get the loop variable if the parameter is a loop output variable.

Parameters:

var	the loop output variable

Returns:

the loop variable

Definition at line 327 of file LoopFor.java.

Vector<SimpleVariable> m2m.backend.structure.LoopFor.getLoopVariables

(

)

Get all loop variables of the loop for.

Returns:

all loop variables of the loop for

Definition at line 218 of file LoopFor.java.

SimpleVariable m2m.backend.structure.LoopFor.getStart

(

)

Getter for start

Returns:

Start

Definition at line 170 of file LoopFor.java.

String m2m.backend.structure.LoopFor.getXmlTagName

(

)

[virtual]

Reimplemented from m2m.backend.structure.Function.

Definition at line 46 of file LoopFor.java.

boolean m2m.backend.structure.LoopFor.insideFromXml	(	org.w3c.dom.Element	el,
		Function	newFunc
	)

Reimplemented from m2m.backend.structure.Function.

Definition at line 51 of file LoopFor.java.

void m2m.backend.structure.LoopFor.insideToXml	(	org.w3c.dom.Element	el,
		Document	dom,
		boolean	shortRef
	)

Reimplemented from m2m.backend.structure.Function.

Definition at line 113 of file LoopFor.java.

void m2m.backend.structure.LoopFor.setEnd

(

SimpleVariable

end

)

Setter for end

Parameters:

end

New end

Definition at line 194 of file LoopFor.java.

void m2m.backend.structure.LoopFor.setIncr

(

SimpleVariable

incr

)

Setter for increment

Parameters:

incr	New increment

Definition at line 178 of file LoopFor.java.

void m2m.backend.structure.LoopFor.setIterOperation

(

Operation

op

)

Set the iterator operation of the loop for.

Parameters:

op	the iterator operation to set to the loop for

Definition at line 226 of file LoopFor.java.

void m2m.backend.structure.LoopFor.setLoopVariables

(

Vector< SimpleVariable >

vector

)

Set loop variables of the loop for.

Parameters:

vector

Loop variables to set to the loop for

Definition at line 210 of file LoopFor.java.

void m2m.backend.structure.LoopFor.setStart

(

SimpleVariable

start

)

Setter for start

Parameters:

start

New start

Definition at line 162 of file LoopFor.java.

String m2m.backend.structure.LoopFor.toOctave

(

int

level

)

Generate the octave code for the element

Parameters:

level

Indent level

Returns:

Octave code

Reimplemented from m2m.backend.structure.Function.

Definition at line 283 of file LoopFor.java.

String m2m.backend.structure.LoopFor.toSchematic	(	int	level,
		String	prefix,
		String	boxFormat,
		String	color
	)

Create the schematic file, use with graphviz to generate schematic

Parameters:

level	Level of tab
prefix	Prefix for the element name
boxFormat	Format of box (rectangle, triangle, ...)
color	Color of the block

Returns:

Generate string

Reimplemented from m2m.backend.structure.Function.

Definition at line 270 of file LoopFor.java.

String m2m.backend.structure.LoopFor.toString

(

int

level

)

Convert the object to a string that contains all the parametres

Parameters:

level

Indent of the string

Returns:

String

Reimplemented from m2m.backend.structure.Function.

Definition at line 239 of file LoopFor.java.

---

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

• /home/ythoma/docs/math2mat/svn/wp1/framework/m2mGUI/src/m2m/backend/structure/LoopFor.java