__________________________________________________[C++ CLASS IMPLEMENTATION] Name: transport/src/TMrbTransport.cxx Purpose: MARaBOU transport mechanism Description: Implements class methods to read MBS data from file or server Author: R. Lutter Mailto: <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a> Revision: $Id: TMrbTransport.cxx,v 1.17 2006-11-07 12:25:31 Rudolf.Lutter Exp $ Date:
TMrbTransport(const Char_t*, const Char_t* XptTitle = "") | |
virtual | ~TMrbTransport() |
void | TObject::AbstractMethod(const char* method) const |
virtual void | TObject::AppendPad(Option_t* option = "") |
virtual void | TObject::Browse(TBrowser* b) |
static TClass* | Class() |
virtual const char* | TObject::ClassName() const |
virtual void | TNamed::Clear(Option_t* option = "") |
void | ClearError() |
virtual TObject* | TNamed::Clone(const char* newname = "") const |
Bool_t | Close() |
Bool_t | CloseLMDFile() |
Bool_t | CloseMEDFile() |
virtual Int_t | TNamed::Compare(const TObject* obj) const |
virtual void | TNamed::Copy(TObject& named) const |
virtual void | TObject::Delete(Option_t* option = "")MENU |
virtual Int_t | TObject::DistancetoPrimitive(Int_t px, Int_t py) |
virtual void | TObject::Draw(Option_t* option = "") |
virtual void | TObject::DrawClass() constMENU |
virtual TObject* | TObject::DrawClone(Option_t* option = "") constMENU |
virtual void | TObject::Dump() constMENU |
virtual void | TObject::Error(const char* method, const char* msgfmt) const |
virtual void | TObject::Execute(const char* method, const char* params, Int_t* error = 0) |
virtual void | TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0) |
virtual void | TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py) |
virtual void | TObject::Fatal(const char* method, const char* msgfmt) const |
virtual void | TNamed::FillBuffer(char*& buffer) |
virtual TObject* | TObject::FindObject(const char* name) const |
virtual TObject* | TObject::FindObject(const TObject* obj) const |
Bool_t | FreeBuffers() |
virtual Option_t* | TObject::GetDrawOption() const |
static Long_t | TObject::GetDtorOnly() |
virtual const char* | TObject::GetIconName() const |
MBSDataIO* | GetMbsBase() |
virtual const char* | TNamed::GetName() const |
virtual char* | TObject::GetObjectInfo(Int_t px, Int_t py) const |
static Bool_t | TObject::GetObjectStat() |
virtual Option_t* | TObject::GetOption() const |
virtual const char* | TNamed::GetTitle() const |
virtual UInt_t | TObject::GetUniqueID() const |
virtual Bool_t | TObject::HandleTimer(TTimer* timer) |
virtual ULong_t | TNamed::Hash() const |
void | Help() |
virtual void | TObject::Info(const char* method, const char* msgfmt) const |
virtual Bool_t | TObject::InheritsFrom(const char* classname) const |
virtual Bool_t | TObject::InheritsFrom(const TClass* cl) const |
virtual void | TObject::Inspect() constMENU |
void | TObject::InvertBit(UInt_t f) |
virtual TClass* | IsA() const |
virtual Bool_t | TObject::IsEqual(const TObject* obj) const |
Bool_t | IsError() |
virtual Bool_t | TObject::IsFolder() const |
Bool_t | TObject::IsOnHeap() const |
virtual Bool_t | TNamed::IsSortable() const |
Bool_t | IsToBeStopped() |
Bool_t | TObject::IsZombie() const |
virtual void | TNamed::ls(Option_t* option = "") const |
void | TObject::MayNotUse(const char* method) const |
const UShort_t* | NextSubevent() |
UInt_t | NextSubevent(UShort_t*) |
virtual Bool_t | TObject::Notify() |
void | TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const |
Bool_t | Open(const Char_t*, const Char_t* Mode = "FILE", Int_t BufferSize = TMrbTransport::kSizeOfData) |
Bool_t | OpenLMDFile(const Char_t* LMDFile) |
Bool_t | OpenLogFile(const Char_t*) |
Bool_t | OpenMEDFile(const Char_t* MEDFile) |
static void | TObject::operator delete(void* ptr) |
static void | TObject::operator delete(void* ptr, void* vp) |
static void | TObject::operator delete[](void* ptr) |
static void | TObject::operator delete[](void* ptr, void* vp) |
void* | TObject::operator new(size_t sz) |
void* | TObject::operator new(size_t sz, void* vp) |
void* | TObject::operator new[](size_t sz) |
void* | TObject::operator new[](size_t sz, void* vp) |
TNamed& | TNamed::operator=(const TNamed& rhs) |
virtual void | TObject::Paint(Option_t* option = "") |
virtual void | TObject::Pop() |
virtual void | TNamed::Print(Option_t* option = "") const |
Bool_t | PrintMbsIoError(const Char_t*) |
virtual Bool_t | ProcessEvent(s_vehe*) |
virtual Int_t | TObject::Read(const char* name) |
Int_t | ReadEvents(Int_t NofEvents = 0) |
virtual void | TObject::RecursiveRemove(TObject* obj) |
void | TObject::ResetBit(UInt_t f) |
virtual void | TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU |
virtual void | TObject::SavePrimitive(ostream& out, Option_t* option = "") |
void | TObject::SetBit(UInt_t f) |
void | TObject::SetBit(UInt_t f, Bool_t set) |
virtual void | TObject::SetDrawOption(Option_t* option = "")MENU |
static void | TObject::SetDtorOnly(void* obj) |
Bool_t | SetDumpInterval(Int_t NofRecs = 0) |
void | SetError() |
virtual void | TNamed::SetName(const char* name)MENU |
virtual void | TNamed::SetNameTitle(const char* name, const char* title) |
static void | TObject::SetObjectStat(Bool_t stat) |
Bool_t | SetShow(const Char_t* BufElemStr = "Events:Subevents", Int_t ScaleDown = 100, const Char_t* Output = NULL) |
Bool_t | SetStat(Int_t ScaleDown = 100, const Char_t* Output = NULL) |
void | SetStopFlag(Bool_t Flag = kTRUE) |
Bool_t | SetStream(Int_t MaxStreams = 0, Int_t SlowDown = 0) |
virtual void | TNamed::SetTitle(const char* title = "")MENU |
virtual void | TObject::SetUniqueID(UInt_t uid) |
Bool_t | Show(const Char_t* BufElemKey = "Subevents", const Char_t* Output = NULL) |
virtual void | ShowMembers(TMemberInspector&) |
Bool_t | ShowStat(const Char_t* Output = NULL) |
virtual Int_t | TNamed::Sizeof() const |
virtual void | Streamer(TBuffer&) |
void | StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b) |
UInt_t | SubeventID() |
UInt_t | SubeventWC() |
virtual void | TObject::SysError(const char* method, const char* msgfmt) const |
Bool_t | TObject::TestBit(UInt_t f) const |
Int_t | TObject::TestBits(UInt_t f) const |
virtual void | TObject::UseCurrentStyle() |
Bool_t | Version() |
virtual void | TObject::Warning(const char* method, const char* msgfmt) const |
virtual Int_t | TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) |
virtual Int_t | TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const |
virtual void | TObject::DoError(int level, const char* location, const char* fmt, va_list va) const |
void | TObject::MakeZombie() |
enum { | kSizeOfData | |
kERROR | ||
kEOF | ||
kEOE | ||
kMaxErrors | ||
}; | ||
enum EMrbRunStatus { | kReady | |
kRunning | ||
kTerminate | ||
kError | ||
}; | ||
enum EMrbTransportMode { | kUndefined | |
kSync | ||
kAsync | ||
kFile | ||
kRemote | ||
}; | ||
enum EMrbBufferElements { | kBufferHeader | |
kFileHeader | ||
kEventHeader | ||
kSubeventHeader | ||
kSubeventData | ||
}; | ||
enum TObject::EStatusBits { | kCanDelete | |
kMustCleanup | ||
kObjInCanvas | ||
kIsReferenced | ||
kHasUUID | ||
kCannotPick | ||
kNoContextMenu | ||
kInvalidObject | ||
}; | ||
enum TObject::[unnamed] { | kIsOnHeap | |
kNotDeleted | ||
kZombie | ||
kBitMask | ||
kSingleKey | ||
kOverwrite | ||
kWriteDelete | ||
}; |
TMrbLofNamedX | fLofBufferElements | ... buffer elements |
TMrbLofNamedX | fLofTransportModes | ... transport modes |
Int_t | fBufferSize | buffer size |
Bool_t | fErrorFlag | error indicator |
TString | fErrorString | error message |
TString | fInputFile | input file |
MBSDataIO* | fMBSDataIO | i/o data base |
TString | TNamed::fName | object identifier |
Bool_t | fStopFlag | kTRUE if to be stopped |
TString | TNamed::fTitle | object title |
TMrbTransport::EMrbTransportMode | fTransportMode | transport mode |
__________________________________________________________________[C++ CTOR] Name: TMrbTransport Purpose: Create a MARaBOU transport object Arguments: Char_t * XptName -- name of transport Char_t * XptTitle -- (opt.) title Exceptions: Description: Class constructor Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::Open Purpose: Open connection (file or network) Arguments: Char_t * File -- file name or network addr Char_t * Mode -- transport mode (FILE, SYNC, ASYNC, or REMOTE) Int_t BufferSize -- buffer size (default is 16k) Results: kTRUE/kFALSE Exceptions: Description: Opens a connection to MBS: either reading from file or via network. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::Close Purpose: Close connection (file or network) Arguments: -- Results: kTRUE/kFALSE Exceptions: Description: Closes an open connection to MBS. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::FreeBuffers Purpose: Free data base buffers Arguments: -- Results: kTRUE/kFALSE Exceptions: Description: Removes data base. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::ReadEvents Purpose: Read events from buffer Arguments: Int_t NofEvents -- number of events to be read (0 = ad infinitum) Results: Int_t Rstatus -- status info Exceptions: Description: Reads a given number of events from MBS buffer. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::NextSubevent Purpose: Get next subevent Arguments: UShort_t SevtData -- pointer to (unpacked) subevent data Results: Int_t Swc -- word count Exceptions: Description: Unpacks next subevent from current event. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::ProcessEvent Purpose: Process event data Arguments: s_vehe * EventData -- pointer to event data (including header) Results: kTRUE/kFALSE Exceptions: Description: This is the event filling function. User will be called by method Analyze(). Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::NextSubevent Purpose: Get next subevent Arguments: none Results: const UShort_t * SevtData -- pointer to current (unpacked) data Exceptions: Description: Unpacks next subevent from current event. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::Show Purpose: Show buffer elem data Arguments: Char_t * BufElemKey -- buffer elem key (one char out of "FBES") Char_t * Output -- output stream (NULL = stdout) Results: kTRUE/kFALSE Exceptions: Description: Outputs samples of buffer element data. Buffer element may be: F(ileheader), B(uffer), E(vent), or S(ubevent) Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::SetShow Purpose: Define show profile Arguments: Char_t * BufElemStr -- string of buffer elem keys (out of "FBES") Int_t ScaleDown -- scale down Char_t * Output -- output stream (NULL = stdout) Results: kTRUE/kFALSE Exceptions: Description: Defines which buffer elements to be shown automatically. Buffer elements may be: F(ileheader), B(uffer), E(vent), or S(ubevent) Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::SetStat Purpose: Define statistics profile Arguments: Int_t ScaleDown -- scale down Char_t * Output -- output stream (NULL = stdout) Results: kTRUE/kFALSE Exceptions: Description: Defines a scale down factor for automatic stats output. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::SetStream Purpose: Define stream profile Arguments: Int_t MaxStreams -- max number of streams to be processed (0 = ad infinitum) Int_t SlowDown -- number of secs to wait after each request Results: kTRUE/kFALSE Exceptions: Description: Defines how many streams to be processed. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::SetDumpInterval Purpose: Define dump interval Arguments: Int_t NofRecs -- dump interval Results: kTRUE/kFALSE Exceptions: Description: Defines when to dump records to disk. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::OpenMEDFile Purpose: Open MED file Arguments: Char_t * MEDFile -- file name Results: kTRUE/kFALSE Exceptions: Description: Opens a file to write data as MBS events. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::CloseMEDFile Purpose: Close MED file Arguments: -- Results: kTRUE/kFALSE Exceptions: Description: Closes MED file which is currently open Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::OpenLMDFile Purpose: Open LMD file Arguments: Char_t * LMDFile -- lmd file Results: kTRUE/kFALSE Exceptions: Description: Opens a file to write original LMD data. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::CloseLMDFile Purpose: Close LMD file Arguments: -- Results: kTRUE/kFALSE Exceptions: Description: Closes LMD file which is currently open Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::OpenLogFile Purpose: Open file for log output Arguments: Char_t * LogFile -- log file Results: kTRUE/kFALSE Exceptions: Description: Opens a file for data/error logging. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::PrintMbsIoError Purpose: Output errors coming from mbsio package Arguments: Char_t * Prefix -- prefix to be output in front Results: kTRUE/kFALSE Exceptions: Description: Reports errors passed over by mbsio package. Keywords:
________________________________________________________________[C++ METHOD] Name: TMrbTransport::Version Purpose: Output version Arguments: -- Results: kTRUE Exceptions: Description: Outputs some welcome text. Keywords: