net.sourceforge.anotherfsm.qfsm

Class QfsmMachine

java.lang.Object

net.sourceforge.anotherfsm.qfsm.QfsmMachine

public class QfsmMachine
extends java.lang.Object

Representation of machine XML element.

Author:

Michal Turek

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QfsmMachine.ArrowType The arrow type.
static class	QfsmMachine.MachineType The state machine type.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	author The author of the state machine.
private java.lang.String	description The description of the state machine.
private QfsmMachine.ArrowType	drawArrowType The arrow type.
private boolean	drawDisplayInitialTransition The initial transition should be drawn.
private java.lang.String	drawStateFont The font family name used to draw the state names.
private boolean	drawStateFontItalic The font style used to draw the state names is italic.
private int	drawStateFontSize The point size of the font used to draw the state names.
private int	drawStateFontWeight Weight of the font used to draw the state names which is one of the enumerated values from QFont::Weight.
private java.lang.String	drawTransitionFont The font family name used to draw the transition conditions.
private boolean	drawTransitionFontItalic The font style used to draw the transition conditions is italic.
private int	drawTransitionFontSize The point size of the font used to draw the transition conditions.
private int	drawTransitionFontWeight Weight of the font used to draw the transition conditions which is one of the enumerated values from QFont::Weight.
private QfsmInitialTransition	initialTransition The initial transition, optional.
private java.lang.String	inputNames The names of the input bits.
private java.lang.String	name The name of the state machine.
private int	numEncodingBits The effective number of encoding bits.
private int	numInputs The number of input bits.
private int	numMooreOutputs The number of bits used to code the state.
private int	numOutputs The number of output bits.
private java.lang.String	outputNames The names of the output bits.
private java.lang.String	outputNamesMoore The names of the moore outputs (state coding).
private QfsmState	startState The start/initial state.
private int	startStateId The start/initial state ID, optional.
private java.util.List<QfsmState>	states The states.
private java.util.List<QfsmTransition>	transitions The transitions.
private QfsmMachine.MachineType	type The type of the state machine.
static int	UNDEFINED_ID The value of undefined state ID.
private java.lang.String	version The version of the state machine.

Constructor Summary

Constructors

Constructor and Description
QfsmMachine()

Method Summary

Methods

Modifier and Type	Method and Description
(package private) void	evaluateStates() Evaluate state IDs to object references.
java.lang.String	getAuthor()
java.lang.String	getDescription()
QfsmMachine.ArrowType	getDrawArrowType()
java.lang.String	getDrawStateFont()
int	getDrawStateFontSize()
int	getDrawStateFontWeight()
java.lang.String	getDrawTransitionFont()
int	getDrawTransitionFontSize()
int	getDrawTransitionFontWeight()
QfsmInitialTransition	getInitialTransition()
java.lang.String	getInputNames()
java.lang.String	getName()
int	getNumEncodingBits()
int	getNumInputs()
int	getNumMooreOutputs()
int	getNumOutputs()
java.lang.String	getOutputNames()
java.lang.String	getOutputNamesMoore()
QfsmState	getStartState()
int	getStartStateId()
(package private) QfsmState	getState(int stateId) Get a state with a specified ID.
(package private) QfsmState	getState(java.lang.String stateName) Get a state with a specified name.
java.util.List<QfsmState>	getStates()
(package private) QfsmTransition	getTransition(int startStateId, java.lang.String inputEvent, int destinationStateId)
java.util.List<QfsmTransition>	getTransitions()
QfsmMachine.MachineType	getType()
java.lang.String	getVersion()
boolean	isDrawDisplayInitialTransition()
boolean	isDrawStateFontItalic()
boolean	isDrawTransitionFontItalic()
void	setAuthor(java.lang.String author)
void	setDescription(java.lang.String description)
void	setDrawArrowType(QfsmMachine.ArrowType drawArrowType)
void	setDrawDisplayInitialTransition(boolean drawDisplayInitialTransition)
void	setDrawStateFont(java.lang.String drawStateFont)
void	setDrawStateFontItalic(boolean drawStateFontItalic)
void	setDrawStateFontSize(int drawStateFontSize)
void	setDrawStateFontWeight(int drawStateFontWeight)
void	setDrawTransitionFont(java.lang.String drawTransitionFont)
void	setDrawTransitionFontItalic(boolean drawTransitionFontItalic)
void	setDrawTransitionFontSize(int drawTransitionFontSize)
void	setDrawTransitionFontWeight(int drawTransitionFontWeight)
void	setInitialTransition(QfsmInitialTransition initialTransition)
void	setInputNames(java.lang.String inputNames)
void	setName(java.lang.String name)
void	setNumEncodingBits(int numEncodingBits)
void	setNumInputs(int numInputs)
void	setNumMooreOutputs(int numMooreOutputs)
void	setNumOutputs(int numOutputs)
void	setOutputNames(java.lang.String outputNames)
void	setOutputNamesMoore(java.lang.String outputNamesMoore)
void	setStartState(QfsmState startState)
void	setStartStateId(int startStateId)
void	setStates(java.util.List<QfsmState> states)
void	setTransitions(java.util.List<QfsmTransition> transitions)
void	setType(QfsmMachine.MachineType type)
void	setVersion(java.lang.String version)

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED_ID

public static final int UNDEFINED_ID

The value of undefined state ID.

See Also:

Constant Field Values

name

private java.lang.String name

The name of the state machine.

version

private java.lang.String version

The version of the state machine.

author

private java.lang.String author

The author of the state machine.

description

private java.lang.String description

The description of the state machine.

type

private QfsmMachine.MachineType type

The type of the state machine.

numMooreOutputs

private int numMooreOutputs

The number of bits used to code the state.

numEncodingBits

private int numEncodingBits

The effective number of encoding bits.

numInputs

private int numInputs

The number of input bits.

numOutputs

private int numOutputs

The number of output bits.

startStateId

private int startStateId

The start/initial state ID, optional.

See Also:

UNDEFINED_ID

startState

private QfsmState startState

The start/initial state. May be null if start state is not defined.

drawStateFont

private java.lang.String drawStateFont

The font family name used to draw the state names.

drawStateFontSize

private int drawStateFontSize

The point size of the font used to draw the state names.

drawStateFontWeight

private int drawStateFontWeight

Weight of the font used to draw the state names which is one of the enumerated values from QFont::Weight. See http://qt-project.org/doc/qt-4.8/qfont.html#Weight-enum.

drawStateFontItalic

private boolean drawStateFontItalic

The font style used to draw the state names is italic.

drawTransitionFont

private java.lang.String drawTransitionFont

The font family name used to draw the transition conditions.

drawTransitionFontSize

private int drawTransitionFontSize

The point size of the font used to draw the transition conditions.

drawTransitionFontWeight

private int drawTransitionFontWeight

Weight of the font used to draw the transition conditions which is one of the enumerated values from QFont::Weight. See http://qt-project.org/doc/qt-4.8/qfont.html#Weight-enum.

drawTransitionFontItalic

private boolean drawTransitionFontItalic

The font style used to draw the transition conditions is italic.

drawArrowType

private QfsmMachine.ArrowType drawArrowType

The arrow type.

drawDisplayInitialTransition

private boolean drawDisplayInitialTransition

The initial transition should be drawn.

inputNames

private java.lang.String inputNames

The names of the input bits.

outputNames

private java.lang.String outputNames

The names of the output bits.

outputNamesMoore

private java.lang.String outputNamesMoore

The names of the moore outputs (state coding).

states

private java.util.List<QfsmState> states

The states.

transitions

private java.util.List<QfsmTransition> transitions

The transitions.

initialTransition

private QfsmInitialTransition initialTransition

The initial transition, optional. May be null if initial transition is not defined.

Constructor Detail

QfsmMachine

public QfsmMachine()

Method Detail

getState

QfsmState getState(java.lang.String stateName)
             throws QfsmException

Get a state with a specified name.

Parameters:

stateName - the name

Returns:

the state

Throws:

QfsmException - if the state does not exist

getState

QfsmState getState(int stateId)
             throws QfsmException

Get a state with a specified ID.

Parameters:

stateId - the state ID

Returns:

the state

Throws:

QfsmException - if the state does not exist

getTransition

QfsmTransition getTransition(int startStateId,
                           java.lang.String inputEvent,
                           int destinationStateId)
                       throws QfsmException

Throws:

QfsmException

evaluateStates

void evaluateStates()
              throws QfsmException

Evaluate state IDs to object references.

Throws:

QfsmException - if some of the states does not exist

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

getAuthor

public java.lang.String getAuthor()

setAuthor

public void setAuthor(java.lang.String author)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getType

public QfsmMachine.MachineType getType()

setType

public void setType(QfsmMachine.MachineType type)

getNumMooreOutputs

public int getNumMooreOutputs()

setNumMooreOutputs

public void setNumMooreOutputs(int numMooreOutputs)

getNumEncodingBits

public int getNumEncodingBits()

setNumEncodingBits

public void setNumEncodingBits(int numEncodingBits)

getNumInputs

public int getNumInputs()

setNumInputs

public void setNumInputs(int numInputs)

getNumOutputs

public int getNumOutputs()

setNumOutputs

public void setNumOutputs(int numOutputs)

getStartStateId

public int getStartStateId()

setStartStateId

public void setStartStateId(int startStateId)

getStartState

public QfsmState getStartState()

setStartState

public void setStartState(QfsmState startState)

getDrawStateFont

public java.lang.String getDrawStateFont()

setDrawStateFont

public void setDrawStateFont(java.lang.String drawStateFont)

getDrawStateFontSize

public int getDrawStateFontSize()

setDrawStateFontSize

public void setDrawStateFontSize(int drawStateFontSize)

getDrawStateFontWeight

public int getDrawStateFontWeight()

setDrawStateFontWeight

public void setDrawStateFontWeight(int drawStateFontWeight)

isDrawStateFontItalic

public boolean isDrawStateFontItalic()

setDrawStateFontItalic

public void setDrawStateFontItalic(boolean drawStateFontItalic)

getDrawTransitionFont

public java.lang.String getDrawTransitionFont()

setDrawTransitionFont

public void setDrawTransitionFont(java.lang.String drawTransitionFont)

getDrawTransitionFontSize

public int getDrawTransitionFontSize()

setDrawTransitionFontSize

public void setDrawTransitionFontSize(int drawTransitionFontSize)

getDrawTransitionFontWeight

public int getDrawTransitionFontWeight()

setDrawTransitionFontWeight

public void setDrawTransitionFontWeight(int drawTransitionFontWeight)

isDrawTransitionFontItalic

public boolean isDrawTransitionFontItalic()

setDrawTransitionFontItalic

public void setDrawTransitionFontItalic(boolean drawTransitionFontItalic)

getDrawArrowType

public QfsmMachine.ArrowType getDrawArrowType()

setDrawArrowType

public void setDrawArrowType(QfsmMachine.ArrowType drawArrowType)

isDrawDisplayInitialTransition

public boolean isDrawDisplayInitialTransition()

setDrawDisplayInitialTransition

public void setDrawDisplayInitialTransition(boolean drawDisplayInitialTransition)

getInputNames

public java.lang.String getInputNames()

setInputNames

public void setInputNames(java.lang.String inputNames)

getOutputNames

public java.lang.String getOutputNames()

setOutputNames

public void setOutputNames(java.lang.String outputNames)

getOutputNamesMoore

public java.lang.String getOutputNamesMoore()

setOutputNamesMoore

public void setOutputNamesMoore(java.lang.String outputNamesMoore)

getStates

public java.util.List<QfsmState> getStates()

setStates

public void setStates(java.util.List<QfsmState> states)

getTransitions

public java.util.List<QfsmTransition> getTransitions()

setTransitions

public void setTransitions(java.util.List<QfsmTransition> transitions)

getInitialTransition

public QfsmInitialTransition getInitialTransition()

setInitialTransition

public void setInitialTransition(QfsmInitialTransition initialTransition)