ca.uqac.lif.labpal.macro

Class Macro

java.lang.Object

ca.uqac.lif.labpal.macro.Macro

Direct Known Subclasses:

MacroMap, MacroScalar

public abstract class Macro
extends java.lang.Object

Basic class for representing macros

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_id The macro's ID
protected Laboratory	m_lab The lab associated to the macro

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Macro(Laboratory lab) Creates a new macro

Method Summary

Modifier and Type	Method and Description
ca.uqac.lif.petitpoucet.NodeFunction	getDependency()
int	getId() Gets the ID associated to the data point
Laboratory	getLaboratory() Gets the laboratory associated to the macro
static void	resetCounter() Resets the ID counter for macros
java.lang.String	toLatex() Exports the contents of this data point as a LaTeX command
abstract java.lang.String	toLatex(boolean with_comments) Exports the contents of this data point as a LaTeX command

Methods inherited from class java.lang.Object

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

Field Detail

m_id

protected int m_id

The macro's ID

m_lab

protected final Laboratory m_lab

The lab associated to the macro

Constructor Detail

Macro

protected Macro(Laboratory lab)

Creates a new macro

Parameters:

lab - The lab this macro is associated with

Method Detail

getId

public int getId()

Gets the ID associated to the data point

Returns:

The ID

getLaboratory

public Laboratory getLaboratory()

Gets the laboratory associated to the macro

Returns:

The lab

toLatex

public final java.lang.String toLatex()

Exports the contents of this data point as a LaTeX command

Returns:

The string defining the command

toLatex

public abstract java.lang.String toLatex(boolean with_comments)

Exports the contents of this data point as a LaTeX command

Parameters:

with_comments - Set to true to add comments before the command definition

Returns:

The string defining the command

getDependency

public ca.uqac.lif.petitpoucet.NodeFunction getDependency()

resetCounter

public static void resetCounter()

Resets the ID counter for macros