JavaGrinders.spatial
Class Animal

java.lang.Object
  extended by java.util.AbstractCollection<E>
      extended by java.util.AbstractList<E>
          extended by java.util.Vector
              extended by JavaGrinders.Variable
                  extended by JavaGrinders.spatial.CaptureVariable
                      extended by JavaGrinders.spatial.Animal
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess
Direct Known Subclasses:
SocialAnimal

public class Animal
extends CaptureVariable
implements java.lang.Cloneable

characterizes an animal as a spatially explicit entity.

See Also:
Serialized Form

Field Summary
 MoveVector moveInStore
           
 
Fields inherited from class JavaGrinders.spatial.CaptureVariable
latlong
 
Fields inherited from class JavaGrinders.Variable
allData, autoExtracted, df, itsDescriptives, itsHighlitedColor, itsLineColor, itsLocationColor, rand
 
Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData
 
Fields inherited from class java.util.AbstractList
modCount
 
Constructor Summary
Animal()
          Empty constructor for the Animal class
Animal(java.lang.String name)
          Constructor for the Animal class
Animal(java.lang.String name, Group aPop)
          Standard constructor for the Animal class
 
Method Summary
 long getCurrentTime()
          returns the current time stamp
 boolean withinConstraint(SpatialVector aLocation)
          sets a constraint for the movement of the animal
 boolean withinTimeScope(long aTime)
          check whether the time provided is withinthe time scope of the animal
 
Methods inherited from class JavaGrinders.spatial.CaptureVariable
addMove, applyRandomMoveFromDistribution, asCircularGraph, asCircularGraph, asSpatialMap, asSpatialMap, asSpatialMap, asSpatialSpeedMap, asSpatialSpeedMap, checkConnectedCoords, cloneSelectedRowsOnly, copySpatialDescriptives, estimateD, fill, fill, fill, fill, fill, fill, fillDescriptives, fillWithGaussRandom, fillWithRandomFromDistribution, getAnglesFromCenter, getCapture, getCenterLocation, getConnect, getConstraint, getCurrentLocation, getDistanceMatrix, getDistancesToLocation, getEndCapture, getEndTime, getFractalDimension, getFractalDimension, getGroupDescriptives, getHomeRange_MinimumPolygon, getHotellingFResults, getLatLongAsDistances, getMeanDistanceToLocation, getMinNeighborDistance, getMoveDistances, getMoves, getMoves, getNetDisplacement, getNetMove, getNetTime, getSpatialDescriptives, getSpatialVector, getSpeeds, getSSCP, getStartCapture, getStartTime, getStringValue, getTimeBetweenFrames, getTimeRefs, getTimes, getTinyStepPath, getXs, getYs, getZs, listCircularDescriptives, listDistanceMatrix, listFractalDimension, listFractalDimension, listGroupDescriptives, listMoveDescriptives, makeNewDescriptives, reMapInConstraint, resamplePath, selectAbove, selectAboveDistance, selectAboveEqual, selectAboveSpeed, selectAfter, selectAfterEqual, selectBefore, selectBeforeEqual, selectBelow, selectBelowDistance, selectBelowEqual, selectBelowSpeed, selectBetween, selectInArea, selectXAbove, selectXAboveEqual, selectXBelow, selectXBelowEqual, selectYAbove, selectYAboveEqual, selectYBelow, selectYBelowEqual, selectZAbove, selectZAboveEqual, selectZBelow, selectZBelowEqual, setConnect, setConstraint, setExternalMovesDistribution, setMaxMovingThreshold, setMinMovingThreshold, writeKMLCoords, writeKMLFile, writeKMLFile, writeKMLIntro, writeKMLLine, writeKMLLineStyle, writeKMLOutro, writeKMLPoints
 
Methods inherited from class JavaGrinders.Variable
addValue, append, appendVariable, asJAMAMatrix, asVariableOrganizer, checkMatchingRows, checkMinUseRows, checkNumberIDs, checkSameIDs, checkSameSelectRows, checkSameSelectRows, checkSameUseRows, checkSameUseRows, checkValidRowRange, clone, cloneVariableFrom, combineSelectedWithSavedSelectedRows, copyDescriptives, copySelectStateFrom, customColorSelectedRows, deleteAllRows, deleteDuplicateRows, deleteMissingRows, deleteNonSelectedRows, deleteRow, deleteSelectedRows, deselectAllRows, fill, fill, fill, fill, fill, fill, fillDescriptives, fillIDs, fillWithParser, fillWithParser, fillWithVariable, findFirstValidRow, findLastValidRow, findNextNonMissingRow, findNextValidRow, findNextValue, findPreviousValidRow, getabasedintValue, getAbasedintValue, getArray, getbooleanValue, getcharValue, getCombinedIDs, getCrossTabulation, getCrossTabulation, getCustomColorRow, getDescriptives, getdoubleArray, getdoubleValue, getfloatValue, getFrequencies, getHighliteColor, getHighlitedRow, getIDMap, getIDs, getIDString, getIDStrings, getInteractions, getintValue, getJaccard, getLineColor, getLocationColor, getlongValue, getManhattan, getMissingRow, getName, getNIDs, getNMissingRows, getNotes, getNRows, getNSelectRows, getNUseRows, getNValidRows, getOrganizer, getProximity, getProximity, getRandomValue, getRowOrder, getRowOrderRow, getSelectRow, getSquEuclidian, getStringArray, getTransitions, getUseRow, getValue, getVariableDesignRole, getVariableDesignRoleString, getVariableFormat, getVariableType, highliteSelectedRows, highliteSelectedRows, invalidDescriptives, invertSelectedRows, isAngleType, isContinuousType, isLocationType, isLocked, isNominalType, isOrdinalType, isXVariable, isYVariable, listDescriptives, listDescriptives, listGroupDescriptivesNoDia, listRowOrder, listRows, listRows, listRows, listSelectedRows, listSelectState, listSelectState, listUseRows, makeTableSubSet, matchedIDs, replaceSelectedRows, restoreSelectedRows, restrictToMatchingUseRows, restrictToMatchingUseRows, restrictToValidRowsOnly, reverseRows, saveSelectedRows, selectAllRows, selectDuplicateRows, selectRows, selectUseRows, selectValue, setAnglesType, setCustomColorRow, setFormula, setHighliteColor, setHighlitedRow, setLineColor, setLocationColor, setLocationsType, setLock, setMissingRow, setName, setNominalType, setNotes, setNRows, setOrdinalType, setOrganizer, setRowOrder, setRowOrderRow, setSelectRow, setSelectRows, setSelectRowsToMissing, setValue, setValue, setValue, setValue, setValue, setValue, setVariableDesignRole, setVariableFormat, setVariableType, sort, sort, sort2, updateRowOrder
 
Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize
 
Methods inherited from class java.util.AbstractList
iterator, listIterator, listIterator
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.List
iterator, listIterator, listIterator
 

Field Detail

moveInStore

public MoveVector moveInStore
Constructor Detail

Animal

public Animal()
       throws java.lang.Exception
Empty constructor for the Animal class

Throws:
java.lang.Exception

Animal

public Animal(java.lang.String name)
       throws java.lang.Exception
Constructor for the Animal class

Throws:
java.lang.Exception

Animal

public Animal(java.lang.String name,
              Group aPop)
       throws java.lang.Exception
Standard constructor for the Animal class

Throws:
java.lang.Exception
Method Detail

withinConstraint

public boolean withinConstraint(SpatialVector aLocation)
                         throws java.lang.Exception
sets a constraint for the movement of the animal

Parameters:
aLocation - a location to check whether it is located within the spatial constraint
Throws:
java.lang.Exception

withinTimeScope

public boolean withinTimeScope(long aTime)
                        throws java.lang.Exception
check whether the time provided is withinthe time scope of the animal

Parameters:
aTime - the time to look up
Throws:
java.lang.Exception

getCurrentTime

public long getCurrentTime()
returns the current time stamp