Package jgromacs.data
Class FrameIndexSet
- java.lang.Object
-
- jgromacs.data.FrameIndexSet
-
- All Implemented Interfaces:
java.lang.Cloneable
public class FrameIndexSet extends java.lang.Object implements java.lang.Cloneable
Objects of this class represent a single frame index set
-
-
Constructor Summary
Constructors Constructor Description FrameIndexSet()
Constructs a new FrameIndexSet objectFrameIndexSet(java.lang.String name)
Constructs a new FrameIndexSet object of a given nameFrameIndexSet(java.util.ArrayList<java.lang.Integer> list)
Constructs a new FrameIndexSet object and loads data from an ArrayListFrameIndexSet(java.util.ArrayList<java.lang.Integer> list, java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from an ArrayListFrameIndexSet(java.util.TreeSet<java.lang.Integer> set)
Constructs a new FrameIndexSet object and loads data from a TreeSetFrameIndexSet(java.util.TreeSet<java.lang.Integer> set, java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from a TreeSetFrameIndexSet(FrameIndexSet set)
Constructs a new FrameIndexSet object identical to a given FrameIndexSet
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFrame(int frame_index)
Adds a new frame to the frame index setjava.lang.Object
clone()
Returns an identical FrameIndexSet objectboolean
equals(java.lang.Object other)
Returns true if this frame index set is identical to anotherjava.util.ArrayList<java.lang.Integer>
getAsArrayList()
Returns frame index set as an ArrayListjava.util.TreeSet<java.lang.Integer>
getAsTreeSet()
Returns frame index set as a TreeSetjava.lang.String
getName()
Returns the name of frame index setint
getNumberOfFrames()
Returns the number of frames in this frame index setint
hashCode()
Returns hash codeFrameIndexSet
intersect(FrameIndexSet other)
Returns the intersection of this frame index set and anotherboolean
isFrameIn(int frame_index)
Returns true if the frame index set contains a given frame indexvoid
removeFrame(int frame_index)
Removes a frame from the frame index setvoid
setName(java.lang.String name)
Sets the name of frame index setFrameIndexSet
subtract(FrameIndexSet other)
Returns the subtraction of another frame index set from this frame index setjava.lang.String
toString()
Returns the String representation of frame index setjava.lang.String
toStringInfo()
Returns summary information about the frame index setFrameIndexSet
union(FrameIndexSet other)
Returns the union of this frame index set and another
-
-
-
Constructor Detail
-
FrameIndexSet
public FrameIndexSet()
Constructs a new FrameIndexSet object
-
FrameIndexSet
public FrameIndexSet(java.lang.String name)
Constructs a new FrameIndexSet object of a given name
-
FrameIndexSet
public FrameIndexSet(java.util.ArrayList<java.lang.Integer> list)
Constructs a new FrameIndexSet object and loads data from an ArrayList
-
FrameIndexSet
public FrameIndexSet(java.util.ArrayList<java.lang.Integer> list, java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from an ArrayList
-
FrameIndexSet
public FrameIndexSet(java.util.TreeSet<java.lang.Integer> set)
Constructs a new FrameIndexSet object and loads data from a TreeSet
-
FrameIndexSet
public FrameIndexSet(java.util.TreeSet<java.lang.Integer> set, java.lang.String name)
Constructs a new FrameIndexSet object of a given name and loads data from a TreeSet
-
FrameIndexSet
public FrameIndexSet(FrameIndexSet set)
Constructs a new FrameIndexSet object identical to a given FrameIndexSet
-
-
Method Detail
-
getName
public java.lang.String getName()
Returns the name of frame index set- Returns:
- Name of frame index set
-
setName
public void setName(java.lang.String name)
Sets the name of frame index set
-
getAsTreeSet
public java.util.TreeSet<java.lang.Integer> getAsTreeSet()
Returns frame index set as a TreeSet- Returns:
- frame index set as a TreeSet
-
getAsArrayList
public java.util.ArrayList<java.lang.Integer> getAsArrayList()
Returns frame index set as an ArrayList- Returns:
- frame index set as an ArrayList
-
getNumberOfFrames
public int getNumberOfFrames()
Returns the number of frames in this frame index set- Returns:
- number of frames
-
isFrameIn
public boolean isFrameIn(int frame_index)
Returns true if the frame index set contains a given frame index
-
addFrame
public void addFrame(int frame_index)
Adds a new frame to the frame index set
-
removeFrame
public void removeFrame(int frame_index)
Removes a frame from the frame index set
-
intersect
public FrameIndexSet intersect(FrameIndexSet other)
Returns the intersection of this frame index set and another- Returns:
- intersection of two frame index sets
-
subtract
public FrameIndexSet subtract(FrameIndexSet other)
Returns the subtraction of another frame index set from this frame index set- Returns:
- subtraction of two frame index sets
-
union
public FrameIndexSet union(FrameIndexSet other)
Returns the union of this frame index set and another- Returns:
- union of two frame index sets
-
toString
public java.lang.String toString()
Returns the String representation of frame index set- Overrides:
toString
in classjava.lang.Object
- Returns:
- String representation
-
toStringInfo
public java.lang.String toStringInfo()
Returns summary information about the frame index set- Returns:
- summary information
-
equals
public boolean equals(java.lang.Object other)
Returns true if this frame index set is identical to another- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
Returns hash code- Overrides:
hashCode
in classjava.lang.Object
-
clone
public java.lang.Object clone()
Returns an identical FrameIndexSet object- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of the frame index set
-
-