My Project
Public Member Functions
TwoDimElementContainer Class Reference

Define a two dimensional detector with ElementContainer. More...

#include <TwoDimElementContainer.hh>

List of all members.

Public Member Functions

 TwoDimElementContainer (vector< UInt4 > Dimension)
 TwoDimElementContainer ()
 ~TwoDimElementContainer ()
 TwoDimElementContainer (const TwoDimElementContainer &ob)
TwoDimElementContainer operator= (const TwoDimElementContainer ob)
HeaderBase PutHeader ()
HeaderBasePutHeaderPointer ()
void InputHeader (HeaderBase Header)
ElementContaineroperator() (UInt4 Xindex, UInt4 Yindex)
ElementContainer Put (UInt4 Xindex, UInt4 Yindex)
vector< UInt4 > PutDimension ()
ElementContainerMatrix ConvertToMatrix ()
vector< ElementContainerPutPackedContainer ()
void InputPackedContainer (vector< ElementContainer > obj)

Detailed Description

Define a two dimensional detector with ElementContainer.

A two dimensional area detector will be defined with this class. Because the dimension, the number of detector elements, is defined in the constructor, you should not use the constructor without its argument. If you construct this class with vector<UInt4> v = [3,4,5], this class will have 3+4+5 detector elements. When you want to access the data, use operator()( UInt4 Xindex, UInt4 Yindex ) or Put( UInt4 Xindex, UInt4 Yindex ). Put(2,3) will returns the fourth ElementContainer of third group.


Constructor & Destructor Documentation

TwoDimElementContainer::TwoDimElementContainer ( vector< UInt4 >  Dimension)

Constructor.

Constructor. Probably, you does not need this constructor.

Destructor.

Override the copy constructor.


Member Function Documentation

Convert to ElementContainerMatrix from the object of this class

this method set a header object. If header object has already input in this class, the existing object will be deleted, and set with the argument.

This method is called from the NeXus and network distributing APIs.

ElementContainer * TwoDimElementContainer::operator() ( UInt4  Xindex,
UInt4  Yindex 
)

Return the pointer of ElementContainer. The meaning of the arguments was written in the manual of this class.

TwoDimElementContainer TwoDimElementContainer::operator= ( const TwoDimElementContainer  ob)

Override the operator of "=".

ElementContainer TwoDimElementContainer::Put ( UInt4  Xindex,
UInt4  Yindex 
)

Return the object of ElementContainer. The meaning of the arguments was written in the manual of this class.

vector<UInt4> TwoDimElementContainer::PutDimension ( ) [inline]

Returns the dimension of the detector. The return value is the same as the argument of the constructor.

Returns header object.

Returns the pointer of header object.

This method is called from the NeXus and network distributing APIs.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Friends