com.atakmap.android.maps

Class DoghouseViewModel

java.lang.Object

com.atakmap.android.maps.DoghouseViewModel

public final class DoghouseViewModel
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
boolean	addRow(Doghouse.DoghouseFields key) Add a row to all doghouses.
boolean	areDoghousesVisible()
void	clearRow(int index, Route route) Set the data in `index` to Doghouse.DoghouseFields.BLANK i.e.
void	hideDoghouses() Hide Doghouses.
int	peekSize() Return the current value for the number of rows in the Doghouses.
void	put(int index, Route route, Doghouse.DoghouseFields key, java.lang.Object data)
void	put(Route route, Doghouse.DoghouseFields key, java.lang.Object data) Put data in the Doghouses.
void	removeRow() Remove the last row in all Doghouses.
void	removeRow(int index) Remove the row at `index` in all Doghouses.
void	resetDoghouses() Reset default values in Doghouses.
void	showDoghouses() Show Doghouses.
void	updateRow(int index, Doghouse.DoghouseFields key) Change what data the given row represents.

Methods inherited from class java.lang.Object

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

Method Detail

addRow

public boolean addRow(Doghouse.DoghouseFields key)

Add a row to all doghouses.

Parameters:

key - What type of data does this new row represent

Returns:

false if Doghouses already have the maximum number of rows or if any individual Doghouse was unable to add a row; true otherwise.

clearRow

public void clearRow(int index,
                     Route route)

Set the data in `index` to Doghouse.DoghouseFields.BLANK i.e. '--'

Parameters:

index - Which row to set to BLANK

route - The Route whose Doghouses are having the data cleared

peekSize

public int peekSize()

Return the current value for the number of rows in the Doghouses. This may not reflect the true size since the method is not synchronized hence `peekSize`

Returns:

The current value for the number of rows in the Doghouses.

put

public void put(Route route,
                Doghouse.DoghouseFields key,
                java.lang.Object data)

Put data in the Doghouses.

Parameters:

route - The route having data added to its Doghouses

key - What the data represents

data - An Object who's toString() method returns how the data should be displayed.

put

public void put(int index,
                Route route,
                Doghouse.DoghouseFields key,
                java.lang.Object data)

Parameters:

index -

route -

key -

data -

removeRow

public void removeRow()

Remove the last row in all Doghouses.

removeRow

public void removeRow(int index)

Remove the row at `index` in all Doghouses.

Parameters:

index - Which row to remove

resetDoghouses

public void resetDoghouses()

Reset default values in Doghouses. The defaults include: 1. Turnpoint ID 2. Bearing to Next 3. Distance to Next

updateRow

public void updateRow(int index,
                      Doghouse.DoghouseFields key)

Change what data the given row represents.

Parameters:

index - The row being updated

key - The new data to represent in the given row

showDoghouses

public void showDoghouses()

Show Doghouses.

hideDoghouses

public void hideDoghouses()

Hide Doghouses.

areDoghousesVisible

public boolean areDoghousesVisible()

Returns:

true if Doghouses are set to Visible, false otherwise.