Quick Links: ROOT Homepage Class Index Class Hierarchy

Sections: class description function members data members class charts

class TMrbEsone: public TObject

_________________________________________________[C++ CLASS DEFINITION FILE]

 Name:           esone/inc/TMrbEsone.h
 Purpose:        Interface to the ESONE client library
 Class:          TMrbEsone            -- base class
 Description:    Class definitions to establish an
                 ESONE client/server connection.
 Author:         R. Lutter
 Revision:       $Id: TMrbEsone.h,v 1.10 2007-04-17 11:22:02 Rudolf.Lutter Exp $
 Date:
 Keywords:

Function Members (Methods)

public:

	TMrbEsone(Bool_t Offline = kFALSE)
	TMrbEsone(const Char_t* HostName, Bool_t Offline = kFALSE)
virtual	~TMrbEsone()
void	Abort()
void	TObject::AbstractMethod(const char* method) const
Int_t	AddressScan(const Char_t* Start, const Char_t* Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)
Int_t	AddressScan(TMrbEsoneCnaf& Start, TMrbEsoneCnaf& Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)
Int_t	AddressScan(Int_t Crate, Int_t Start, Int_t Stop, Int_t Function, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)
Bool_t	AddToBroadCast(Int_t Crate, Int_t Station)
virtual void	TObject::AppendPad(Option_t* option = "")
Int_t	BlockXfer(const Char_t* Cnaf, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)
Int_t	BlockXfer(TMrbEsoneCnaf& Cnaf, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)
Int_t	BlockXfer(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)
virtual void	TObject::Browse(TBrowser* b)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TObject::Clear(Option_t* = "")
Bool_t	ClearBroadCast(Int_t Crate)
Bool_t	ClearDW(Int_t Crate)
void	ClearStatus()
virtual TObject*	TObject::Clone(const char* newname = "") const
virtual Int_t	TObject::Compare(const TObject* obj) const
UInt_t	ConnectToHost(const Char_t* HostName, Bool_t Reconnect = kFALSE)
virtual void	TObject::Copy(TObject& object) 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
Bool_t	DWIsInhibited(Int_t Crate)
virtual void	TObject::Error(const char* method, const char* msgfmt) const
Bool_t	ExecCnaf(const Char_t* Cnaf, Bool_t D16Flag = kFALSE)
Bool_t	ExecCnaf(TMrbEsoneCnaf& Cnaf, Bool_t D16Flag = kFALSE)
Bool_t	ExecCnaf(const Char_t* Cnaf, Int_t& Data, Bool_t D16Flag = kFALSE)
Bool_t	ExecCnaf(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Bool_t D16Flag = kFALSE)
Bool_t	ExecCnaf(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Int_t& Data, Bool_t D16Flag = kFALSE)
Int_t	ExecCnafList(TObjArray& CnafList, Bool_t D16Flag = kFALSE)
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 TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
TMrbNamedX*	GetAction()
UInt_t	GetBroadCast(Int_t Crate)
Int_t	GetControllerIndex()
const Char_t*	GetControllerName()
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
const Char_t*	GetError(TString& Error)
TMrbNamedX*	GetHost(UInt_t HostAddr)
TMrbNamedX*	GetHost(const Char_t* HostName)
virtual const char*	TObject::GetIconName() const
virtual const char*	TObject::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
Bool_t	GetQ()
Int_t	GetServerIndex()
const Char_t*	GetServerName()
TSocket*	GetSocket()
UInt_t	GetStatus(Bool_t& XFlag, Bool_t& QFlag, Int_t& ErrorCode, TString& Error)
virtual const char*	TObject::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
Bool_t	GetX()
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
Bool_t	HasBroadCast()
Bool_t	HasBroadCast(Int_t& NsetMask, Int_t& NexecCmd)
Bool_t	HasFastCamac()
virtual ULong_t	TObject::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
Bool_t	InitDW(Int_t Crate)
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	IsAborted()
Bool_t	IsConnected()
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
Bool_t	IsError()
virtual Bool_t	TObject::IsFolder() const
Bool_t	IsMarabouServer()
Bool_t	IsMbsServer()
Bool_t	IsOffline()
Bool_t	TObject::IsOnHeap() const
Bool_t	IsSingleStep()
virtual Bool_t	TObject::IsSortable() const
Bool_t	IsVerbose()
Bool_t	TObject::IsZombie() const
virtual void	TObject::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
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)
TObject&	TObject::operator=(const TObject& rhs)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	Print(Option_t* Option) const
void	Print(TMrbEsoneCnaf& Cnaf)
void	Print(TObjArray& CnafList, Int_t From = 0, Int_t To = -1)
void	PrintError(const Char_t* EsoneCall, const Char_t* Method)
void	PrintStatus(const Char_t* Method)
virtual Int_t	TObject::Read(const char* name)
Bool_t	ReadDoubleWord(Int_t Crate, Bool_t ReadDW = kTRUE)
Bool_t	ReadFromFile(const Char_t* FileName)
virtual void	TObject::RecursiveRemove(TObject* obj)
Bool_t	RemoveFromBroadCast(Int_t Crate, Int_t Station)
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	SetAction(EMrbEsoneCamacAction Action)
Bool_t	SetAutoRead(Int_t Crate, Bool_t AutoRead = kTRUE)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
Bool_t	SetBroadCast(Int_t Crate, UInt_t BroadCast)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
Bool_t	SetDWInhibit(Int_t Crate, Bool_t Flag = kTRUE)
void	SetError()
static void	TObject::SetObjectStat(Bool_t stat)
void	SetOffline(Bool_t Offline = kTRUE)
void	SetQ()
void	SetSingleStep(Bool_t Flag = kTRUE)
virtual void	TObject::SetUniqueID(UInt_t uid)
void	SetVerboseMode(Bool_t VerboseFlag = kTRUE)
void	SetX()
void	SetXQ()
virtual void	ShowMembers(TMemberInspector&)
Bool_t	StartServer(const Char_t* HostName)
virtual void	Streamer(TBuffer&)
void	TObject::StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
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
void	UseBroadCast(Bool_t Flag)
virtual void	TObject::UseCurrentStyle()
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

protected:

Bool_t	CheckConnection(const Char_t* Method)
Bool_t	CheckCrate(Int_t Crate, const Char_t* Method)
virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
Bool_t	EsoneCCCC(Int_t Crate)
Bool_t	EsoneCCCI(Int_t Crate, Bool_t Inhibit = kTRUE)
Bool_t	EsoneCCCZ(Int_t Crate)
Bool_t	EsoneCCOPEN(const Char_t* HostName, UInt_t& HostAddress)
Bool_t	EsoneCDCTRL()
Bool_t	EsoneCDREG(UInt_t& Handle, TMrbEsoneCnaf& Cnaf)
Bool_t	EsoneCDREG(UInt_t& Handle, Int_t Crate, Int_t Station = 0, Int_t SubAddr = 0)
const Char_t*	EsoneCERROR(TString& ErrMsg, Int_t ErrorCode, Bool_t DateFlag)
Bool_t	EsoneCTCI(Int_t Crate)
UInt_t	EsoneCTSTAT()
Int_t	EsoneCXGA(TObjArray& CnafList, Bool_t D16Flag)
Int_t	EsoneCXMAD(TMrbEsoneCnaf& Start, TMrbEsoneCnaf& Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag)
Bool_t	EsoneCXSA(TMrbEsoneCnaf& Cnaf, Bool_t D16Flag)
Int_t	EsoneCXUBX(TMrbEsoneCnaf& Cnaf, TArrayI& Data, Int_t First, Int_t Last, Bool_t D16Flag, Bool_t QXfer)
Bool_t	EsoneSpecial(EMrbEsoneCnafType Type, Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Int_t& Data, Bool_t D16Flag)
void	TObject::MakeZombie()
void	PrintResults(const Char_t* Method, TMrbEsoneCnaf& Cnaf)
void	PrintResults(const Char_t* Method, TObjArray& CnafList)
Bool_t	Reset(Bool_t Offline = kFALSE)
void	SetCB(TArrayI& CB, Int_t Repeat = 0, Int_t Tally = 0, Int_t Lam = 0, Int_t DMA = 0)
Bool_t	StartMarabouServer(const Char_t* HostName)
Bool_t	StartMbsServer(const Char_t* HostName)

Data Members

public:

enum EMrbEsoneServer {	kES_MBS
	kES_MARABOU
};
enum EMrbCamacController {	kCC_CBV
	kCC_CC32
};
enum {	kBroadCastSetMask_N_CC32
	kBroadCastExecCmd_N_CC32
	kFastCamac_F
	kAutoRead_CC32
	kLastError
};
enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

public:

TMrbLofNamedX	fLofCamacActions	list of camac actions
TMrbLofNamedX	fLofCamacFunctions	list of camac function types
TMrbLofNamedX	fLofCnafNames	list of camac registers
TMrbLofNamedX	fLofCnafTypes	list of cnaf types
TMrbLofNamedX	fLofControllers	list of camac controllers available
TMrbLofNamedX	fLofEsoneServers	list of esone servers available

protected:

Bool_t	fAborted	kTRUE if operation aborted
TMrbNamedX*	fAction	last camac action
Int_t	fBufferSize	tcp buffer size
Int_t	fCC32Base	base address (CC32 only)
TMrbNamedX	fController	camac controller used (name+index)
TString	fHost	host name
Int_t	fHostAddr	ESONE host address
TString	fHostInet	full inet address
TMrbC2Lynx*	fLynxClient	client to lynxos/vme
Int_t	fNofCrates	number of crates in use
Bool_t	fOffline	access camac hardware?
Int_t	fPort	port number
TString	fServerPath	where to start server from
TString	fServerProg	server program
TMrbNamedX	fServerType	server type (name+index)
TString	fSetupPath	where to fond setup files
Bool_t	fSingleStep	kTRUE if in single step mode
TSocket*	fSocket	! connection to server
UInt_t	fStatus	status of last camac action
Bool_t	fUseBroadCast	kTRUE if broadcast mode is to be used
Bool_t	fVerboseMode	kTRUE if verbose mode on

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TMrbEsone(Bool_t Offline = kFALSE)

TMrbEsone(const Char_t* HostName, Bool_t Offline = kFALSE)

~TMrbEsone()

{}

Bool_t StartServer(const Char_t* HostName)

Bool_t ClearDW(Int_t Crate)

 cccc: clear dataway (CAMAC-C)

Bool_t InitDW(Int_t Crate)

 cccz: initialize dataway (CAMAC-Z)

Bool_t SetDWInhibit(Int_t Crate, Bool_t Flag = kTRUE)

 ccci: set/clear dataway inhibit (CAMAC-I)

Bool_t DWIsInhibited(Int_t Crate)

 ctci: test dataway inhibit

UInt_t ConnectToHost(const Char_t* HostName, Bool_t Reconnect = kFALSE)

 ccopen: connect to camac host

Bool_t ExecCnaf(const Char_t* Cnaf, Bool_t D16Flag = kFALSE)

 cfsa/cssa: single camac action

Bool_t ExecCnaf(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Bool_t D16Flag = kFALSE)

Bool_t ExecCnaf(const Char_t* Cnaf, Int_t& Data, Bool_t D16Flag = kFALSE)

Bool_t ExecCnaf(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Int_t& Data, Bool_t D16Flag = kFALSE)

Bool_t ExecCnaf(TMrbEsoneCnaf& Cnaf, Bool_t D16Flag = kFALSE)

 cfga/csga: multiple camac action

Int_t ExecCnafList(TObjArray& CnafList, Bool_t D16Flag = kFALSE)

 cfmad/csmad: adress scan

Int_t AddressScan(const Char_t* Start, const Char_t* Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)

Int_t AddressScan(Int_t Crate, Int_t Start, Int_t Stop, Int_t Function, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)

Int_t AddressScan(TMrbEsoneCnaf& Start, TMrbEsoneCnaf& Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag = kFALSE)

 cfubc/csubc, cfubr/csubr: block transfer

Int_t BlockXfer(const Char_t* Cnaf, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)

Int_t BlockXfer(Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)

Int_t BlockXfer(TMrbEsoneCnaf& Cnaf, TArrayI& Data, Int_t Start = 0, Int_t NofWords = -1, Bool_t D16Flag = kFALSE, Bool_t QXfer = kFALSE)

UInt_t GetStatus(Bool_t& XFlag, Bool_t& QFlag, Int_t& ErrorCode, TString& Error)

 ctstat: get status of last camac action

const Char_t * GetError(TString& Error)

TMrbNamedX * GetHost(UInt_t HostAddr)

 camac host

TMrbNamedX * GetHost(const Char_t* HostName)

void SetOffline(Bool_t Offline = kTRUE)

{ fOffline = Offline; }

Bool_t IsOffline()

{ return(fOffline); }

void ClearStatus()

 camac data

{ fStatus = 0; }

void SetX()

{ fStatus |= (UInt_t) kEsoneX; }

void SetQ()

{ fStatus |= (UInt_t) kEsoneQ; }

void SetXQ()

{ fStatus |= (UInt_t) (kEsoneQ|kEsoneX); }

void SetError()

{ fStatus |= (UInt_t) kEsoneError; }

Bool_t GetX()

{ return(IS_X(fStatus)); }

Bool_t GetQ()

{ return(IS_Q(fStatus)); }

Bool_t IsError()

{ return(IS_ERROR(fStatus)); }

TMrbNamedX * GetAction()

{ return(fAction); }

void SetAction(EMrbEsoneCamacAction Action)

{ fAction = fLofCamacActions.FindByIndex(Action); }

Bool_t HasBroadCast()

 broadcast

Bool_t HasBroadCast(Int_t& NsetMask, Int_t& NexecCmd)

Bool_t SetBroadCast(Int_t Crate, UInt_t BroadCast)

Bool_t ClearBroadCast(Int_t Crate)

{ return(this->SetBroadCast(Crate, 0)); }

Bool_t AddToBroadCast(Int_t Crate, Int_t Station)

Bool_t RemoveFromBroadCast(Int_t Crate, Int_t Station)

UInt_t GetBroadCast(Int_t Crate)

void UseBroadCast(Bool_t Flag)

{ fUseBroadCast = Flag; }

Bool_t HasFastCamac()

 special camac functions

Bool_t SetAutoRead(Int_t Crate, Bool_t AutoRead = kTRUE)

Bool_t ReadDoubleWord(Int_t Crate, Bool_t ReadDW = kTRUE)

void Print(Option_t* Option) const

 misc

{ TObject::Print(Option); }

void Print(TMrbEsoneCnaf& Cnaf)

void Print(TObjArray& CnafList, Int_t From = 0, Int_t To = -1)

void PrintError(const Char_t* EsoneCall, const Char_t* Method)

void PrintStatus(const Char_t* Method)

Bool_t ReadFromFile(const Char_t* FileName)

{ return(kTRUE); }

const Char_t * GetServerName()

{ return(fServerType.GetName()); }

Int_t GetServerIndex()

{ return(fServerType.GetIndex()); }

Bool_t IsMarabouServer()

{ return(fServerType.GetIndex() == kES_MARABOU); }

Bool_t IsMbsServer()

{ return(fServerType.GetIndex() == kES_MBS); }

TSocket * GetSocket()

{ return(fSocket); }

const Char_t * GetControllerName()

{ return(fController.GetName()); }

Int_t GetControllerIndex()

{ return(fController.GetIndex()); }

void Help()

{ gSystem->Exec(Form("mrbHelp %s", this->ClassName())); }

void SetVerboseMode(Bool_t VerboseFlag = kTRUE)

{ fVerboseMode = VerboseFlag; }

Bool_t IsVerbose()

{ return(fVerboseMode); }

void Abort()

{ fAborted = kTRUE; }

Bool_t IsAborted()

{ return(fAborted); }

Bool_t IsConnected()

{ return(fHostAddr > 0); }

void SetSingleStep(Bool_t Flag = kTRUE)

{ fSingleStep = Flag; }

Bool_t IsSingleStep()

{ return(fSingleStep); }

Bool_t StartMbsServer(const Char_t* HostName)

Bool_t StartMarabouServer(const Char_t* HostName)

Bool_t Reset(Bool_t Offline = kFALSE)

Bool_t CheckConnection(const Char_t* Method)

Bool_t CheckCrate(Int_t Crate, const Char_t* Method)

void PrintResults(const Char_t* Method, TMrbEsoneCnaf& Cnaf)

void PrintResults(const Char_t* Method, TObjArray& CnafList)

Bool_t EsoneCDREG(UInt_t& Handle, Int_t Crate, Int_t Station = 0, Int_t SubAddr = 0)

Bool_t EsoneCDREG(UInt_t& Handle, TMrbEsoneCnaf& Cnaf)

Bool_t EsoneCDCTRL()

Bool_t EsoneCCCC(Int_t Crate)

Bool_t EsoneCCOPEN(const Char_t* HostName, UInt_t& HostAddress)

Bool_t EsoneCCCI(Int_t Crate, Bool_t Inhibit = kTRUE)

Bool_t EsoneCTCI(Int_t Crate)

Bool_t EsoneCCCZ(Int_t Crate)

UInt_t EsoneCTSTAT()

Bool_t EsoneCXSA(TMrbEsoneCnaf& Cnaf, Bool_t D16Flag)

Int_t EsoneCXGA(TObjArray& CnafList, Bool_t D16Flag)

Int_t EsoneCXMAD(TMrbEsoneCnaf& Start, TMrbEsoneCnaf& Stop, TArrayI& Data, TObjArray& Results, Bool_t D16Flag)

 [csubr, cfubr, csubc, cfubc] block xfer

Bool_t EsoneSpecial(EMrbEsoneCnafType Type, Int_t Crate, Int_t Station, Int_t Subaddr, Int_t Function, Int_t& Data, Bool_t D16Flag)

const Char_t * EsoneCERROR(TString& ErrMsg, Int_t ErrorCode, Bool_t DateFlag)

void SetCB(TArrayI& CB, Int_t Repeat = 0, Int_t Tally = 0, Int_t Lam = 0, Int_t DMA = 0)