Main Page   Packages   Class Hierarchy   Compound List   Compound Members   Related Pages  

SctData.ModuleElement Class Reference

Represents an contiguous element of a module : may be a chip, link, channel or some other region. More...

List of all members.

Public Member Functions

 ModuleElement (int first, int last) throws IllegalArgumentException
 Constructor takes the first and last channel of the element.

int getFirst ()
 First channel contained (0->1535).

int getLast ()
 Last channel contained (0->1535).

int getNChannels ()
 
Returns:
the number of channels (=last-first+1)


boolean isChannel ()
 
Returns:
true if only contains one element


boolean isChip ()
 
Returns:
true if the channels contained precisely match one chip


boolean isLink ()
 
Returns:
true if the channels contained precisely match one link


boolean isModule ()
 
Returns:
true if all of the channels are contained


boolean equals (Object e2)
 explicit equality operator
Returns:
true if first and last are equal


boolean superset (ModuleElement e2)
 
Returns:
true if this element contains all of the RHS element (or equal)


boolean subset (ModuleElement e2)
 
Returns:
true if this element is contained within the RHS element (or equal)


boolean overlaps (ModuleElement e2)
 
Returns:
true if this element overlaps any part of RHS element


String getClassName ()
void write (OStream s, ObjectManager o) throws java.io.IOException

Static Public Member Functions

ModuleElement chip (int chip)
 Creates a ModuleElement that represents a chip.

ModuleElement channel (int channel)
 Creates a ModuleElement that represents a channel.

ModuleElement link (int link)
 Creates a ModuleElement that represents a link.

ModuleElement module ()
 Creates a ModuleElement that represents a module.

ModuleElement read (IStream s, ObjectManager o) throws java.io.IOException


Detailed Description

Represents an contiguous element of a module : may be a chip, link, channel or some other region.


Constructor & Destructor Documentation

SctData.ModuleElement.ModuleElement int    first,
int    last
throws IllegalArgumentException
 

Constructor takes the first and last channel of the element.

0,127 for chip 0 link 0, or perhaps 768, 895 for chip 0 link 1.

Parameters:
first channel contained
last channel contained (inclusive)
Exceptions:
IllegalArgumentException if last<first or last>1535.


Member Function Documentation

ModuleElement SctData.ModuleElement.channel int    channel [static]
 

Creates a ModuleElement that represents a channel.

Parameters:
channel the channel number

ModuleElement SctData.ModuleElement.chip int    chip [static]
 

Creates a ModuleElement that represents a chip.

Parameters:
chip the chip index

ModuleElement SctData.ModuleElement.link int    link [static]
 

Creates a ModuleElement that represents a link.

Parameters:
link the link index


The documentation for this class was generated from the following file:
Generated on Mon Dec 15 19:39:16 2003 for SCT DAQ/DCS Software by doxygen1.3-rc3