cusack.hcg.games.weighted

Class WeightedInstance

java.lang.Object

java.util.Observable

cusack.hcg.model.PuzzleInstance

cusack.hcg.games.weighted.WeightedInstance

All Implemented Interfaces:

DrawableGraphProblem, java.util.Observer

Direct Known Subclasses:

EdgeChooseInstance

public abstract class WeightedInstance
extends PuzzleInstance

Author:

Matt Barbour

Constructor Summary

Constructors

Constructor and Description
WeightedInstance()
WeightedInstance(WeightedInstance wgi)

Method Summary

Modifier and Type	Method and Description
boolean	addEdge(Vertex from, Vertex to, int weight) Adds an edge with a specified weight to the graph in PuzzleInstance
java.lang.String	getAdjacencyMatrixAsString()
int	getWeightForEdge(Edge e) Given an edge, get its weight
boolean	isEventForThisPuzzleType(Event<?> e) Return true iff this event is of type T.
boolean	setWeight(Vertex from, Vertex to, int weight) Changes the weight of the edge between the two passed-in vertices
void	setWeights(java.lang.String weightsList) Sets the weights for the edges in the graph, according to the passed-in String.
void	setWeightsBetween(java.util.List<Vertex> verts, int weight)
void	setWeightsForEdges(java.util.ArrayList<Edge> edges, int weight)
void	setWeightsForEdges(java.util.ArrayList<Edge> edges, int[] weights)
java.lang.String	weightsToString() Dictates how the weights in this Object's graph are arranged in a String

Methods inherited from class cusack.hcg.model.PuzzleInstance

addDoppelganger, addGraph, addGraphWithData, addToSelected, addToSelected, addVertex, canRedo, canUndo, checkAndHandlePuzzleCompletion, clearAllSelections, clearHistory, clearTutorial, computeGlobalPoints, connectAllSelectedVertices, connectToSelected, convertMovesToTutorial, copyPuzzle, copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState, copyRequested, copySelected, createNewVertexForPuzzle, currentPuzzleDataToString, deleteSelected, disableHistory, disconnectFromSelected, disconnectSelected, doNotRecordGraphEvents, enableHistory, endGame, forceRedo, getAttemptName, getBasePoints, getCurrentAnnotation, getCurrentMoveOverview, getCurrentUndoableEvent, getData, getDefaultVertexDataObject, getDescription, getDiameter, getDifficultyLevel, getEdgeDataClassName, getEditHelpClassName, getEditorClassName, getFamilyName, getFirstSelected, getFirstTimeBonus, getGameName, getGlobalBest, getGraph, getHelpClassName, getHighScoreBonus, getImprovementBonus, getInstanceClassName, getInterestingTutorialVertices, getMaximumXCoordinate, getMaximumYCoordinate, getMessage, getMinimumSelectedXCoordinate, getMinimumSelectedYCoordinate, getMinimumXCoordinate, getMinimumYCoordinate, getMode, getNumberOfEdges, getNumberOfMoves, getNumberOfVertices, getNumberSelected, getOldHighScore, getPersonalBest, getPlayClassName, getProcessedSolution, getPuzzleID, getPuzzleInstanceName, getPuzzleName, getScore, getSelectedVertices, getSolution, getSolutionAsString, getSolutionID, getThemeClassName, getTimeTaken, getTopOfUndoStack, getTryItInstanceForUseOnPlayScreen, getTutorialData, getUserID, getVertexIndex, getVertices, getVisibility, getVisibleSources, goToNextEvent, grossHistoryDeleteLastEvent, grossHistoryGetLastAddedEvent, grossHistoryGetNextEvent, grossHistoryGetNextEventIndex, grossHistoryIsSaved, grossHistoryIteratorAtBeginning, grossHistoryIteratorAtEnd, grossHistoryNext, grossHistoryPrevious, grossHistorySetSaved, grossHistorySize, grossHistoryToBeginning, grossHistoryToEnd, initialPuzzleDataToString, isCurrentStateValidSolution, isFinishable, isInReplayOrEditTutorialMode, isLocked, isLowerScoreBetter, isPlayable, isSaved, isShowIndices, isSolutionRefinable, isSpecialCopyOK, isTutorial, isValidToTranslationSelection, isVisibleSource, makeCurrentStateInitialState, moveGraphEnded, moveSelectedVerticesEnded, moveStarted, pasteAndConnectCopyOfSelected, pasteCopyOfSelected, performEvents, performEvents, performTutorialEvents, reallySetLocked, recordGraphEvents, redo, removeFromSelected, removeFromSelected, resetVerticesToInitialLocations, restart, runAlgorithms, runuTryIt, selectAll, sendAlgorithmResult, sendMeaninglessEvent, setAttemptName, setData, setDefaultData, setDescription, setFinishable, setGlobalBest, setGraph, setInReplayOrEditTutorialMode, setLocked, setMessage, setMode, setPersonalBest, setPlayable, setPuzzle, setPuzzleID, setPuzzleName, setSaved, setShowIndices, setSolutionData, setSolutionID, setSolutionInformation, setUserID, setVisibleSources, startTimer, stopTimer, stringToPuzzleData, submit, toggleSelected, tryItResultsAreBinding, tutorialModeEnabled, undo, uniqueIdentifier, update, updateStateBasedOnAlgorithmResult, updateTimeTaken, usesAlgorithms

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

WeightedInstance

public WeightedInstance()

WeightedInstance

public WeightedInstance(WeightedInstance wgi)

Method Detail

setWeights

public void setWeights(java.lang.String weightsList)

Sets the weights for the edges in the graph, according to the passed-in String.

Parameters:

weightsList - The String of weights for all the edges in the graph. It should be arranged as weightsToString() dictates.

setWeightsForEdges

public void setWeightsForEdges(java.util.ArrayList<Edge> edges,
                               int weight)

setWeightsForEdges

public void setWeightsForEdges(java.util.ArrayList<Edge> edges,
                               int[] weights)

setWeightsBetween

public void setWeightsBetween(java.util.List<Vertex> verts,
                              int weight)

Parameters:

verts -

weight -

getWeightForEdge

public int getWeightForEdge(Edge e)

Given an edge, get its weight

Parameters:

e - The edge whose weight we want to know

Returns:

The weight of the edge, if a corresponding EdgeInteger data exists, and 1 if not.

isEventForThisPuzzleType

public boolean isEventForThisPuzzleType(Event<?> e)

Description copied from class: PuzzleInstance

Return true iff this event is of type T. Stupid method that is necessary because Java is dumb. One would like to ask 'if(x instanceof T)', but since Java throws away Generics at runtime, it doesn't know what T is, so you can't ask this. This is an important method because (I think) that this is the only thing that ensure the right sort of objects are placed on history and the wrong ones aren't. Since the UndoRedoHistory is not properly parameterized (don't get me started on how much I hate Generics in Java) I think this method is the only thing that makes sure that if an RecordableEvent calls its performEvent method, that the PuzzleInstance object passed in is the correct one (for instance, a PebbleInstance must be passed if movePebbles is called since otherwise the program will crash). This may only be used in one place, but it is still necessary. CAC, Feb 2010.

Specified by:

isEventForThisPuzzleType in class PuzzleInstance

Returns:

weightsToString

public java.lang.String weightsToString()

Dictates how the weights in this Object's graph are arranged in a String

Returns:

The formatted String containing all of the edge weights for this Object's graph

setWeight

public boolean setWeight(Vertex from,
                         Vertex to,
                         int weight)

Changes the weight of the edge between the two passed-in vertices

Parameters:

from - The vertex the edge starts at

to - The vertex the edge ends at

weight - The new weight

Returns:

true if the edge exists and false otherwise

addEdge

public boolean addEdge(Vertex from,
                       Vertex to,
                       int weight)

Adds an edge with a specified weight to the graph in PuzzleInstance

Parameters:

from - The starting vertex

to - The vertex to end at

weight - The weight for this edge

Returns:

true if the edge does not already exist and false otherwise

getAdjacencyMatrixAsString

public java.lang.String getAdjacencyMatrixAsString()