(UNKNOWN PRODUCT) » UTILS » TMrbSerialComm

class TMrbSerialComm: public TNamed

__________________________________________________[C++IMPLEMENTATION]

 Name:           utils/src/TMrbSerialComm.cxx
 Purpose:        MARaBOU utilities: serial line I/O
 Description:    Implements methods to control a serial port
                 (inspired by class c_SerialComm written by Mario Schubert)
 Keywords:
 Author:         R. Lutter
 Mailto:         <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a>
 Revision:       $Id: TMrbSerialComm.cxx,v 1.7 2007/07/27 11:17:23 Rudolf.Lutter Exp $
 Date:

Function Members (Methods)

public:
TMrbSerialComm()
TMrbSerialComm(const Char_t* Device)
TMrbSerialComm(const TMrbSerialComm&)
virtual~TMrbSerialComm()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTNamed::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
Bool_tClose()
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidTNamed::Copy(TObject& named) const
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidTNamed::FillBuffer(char*& buffer)
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual const char*TObject::GetIconName() const
virtual const char*TNamed::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
const Char_t*GetPort() const
virtual const char*TNamed::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
voidHelp()
voidIgnoreCR(Bool_t Flag)
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
Bool_tIsOpen() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTNamed::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
Bool_tOpen()
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::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)
TMrbSerialComm&operator=(const TMrbSerialComm&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidPrint() const
virtual voidPrint(Option_t* Option) const
virtual Int_tTObject::Read(const char* name)
Int_tReadData(TString& Data)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
voidSetBaudRate(Int_t BaudRate)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
voidSetBits(Int_t DataBits, Int_t StopBits)
voidSetDelay(Double_t Delay)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
voidSetLineTerm1(Char_t Term)
voidSetLineTerm2(Char_t Term)
virtual voidTNamed::SetName(const char* name)MENU
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetParity(TMrbSerialComm::EMrbParity Parity)
voidSetPostfix(const Char_t* Postfix, Bool_t CrFlag = kTRUE)
voidSetPrefix(const Char_t* Prefix)
virtual voidTNamed::SetTitle(const char* title = "")MENU
virtual voidTObject::SetUniqueID(UInt_t uid)
voidSetup(Int_t BaudRate, Int_t NofDataBits = 8, TMrbSerialComm::EMrbParity Parity = kMrbParityNone, Int_t NofStopBits = 1, Bool_t UseRtsCts = kFALSE, Bool_t IgnoreCR = kTRUE)
virtual voidShowMembers(TMemberInspector& insp)
virtual Int_tTNamed::Sizeof() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
voidUseRtsCts(Bool_t Flag)
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
Int_tWriteData(const Char_t* Data)
Int_tWriteSingleBytes(const Char_t* Data, Double_t Delay = -1)
Int_tWriteWithDelay(const Char_t* Data, Double_t Delay = -1)
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
const Char_t*MakePrintable(TString& PrintString, const Char_t* String) const
voidTObject::MakeZombie()

Data Members

public:
enum EMrbParity { kMrbParityNone
kMrbParityOdd
kMrbParityEven
};
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
Int_tfBaudRatebaud rate
Int_tfBytesReceivedtotal of bytes received
Int_tfBytesTransmitted... transmitted
Double_tfDelaydelay [s]
Int_tfFdi/o channel id from open(2)
Bool_tfIgnoreCRkTRUE if <CR> to be ignored
Char_tfLineTerm1line termination
Char_tfLineTerm2...
TStringTNamed::fNameobject identifier
void*fNewTIO! new settings
Int_tfNofDataBitsnumber of data bits
Int_tfNofStopBitsnumber of stop bits
void*fOldTIO! old settings will be saved here
TMrbSerialComm::EMrbParityfParityparity settings
TStringfPostfixsend postfix
TStringfPrefixsend prefix
TStringTNamed::fTitleobject title
Bool_tfUseRtsCtskTRUE if RTS/CTS to be used

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TMrbSerialComm(const Char_t* Device)
__________________________________________________________________[C++ CTOR]

 Name:           TMrbSerialComm
 Purpose:        Control a serial port
 Description:    Class to control I/O from/to a serial port.
 Keywords:
Bool_t Open()
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::Open
 Purpose:        Open serial port
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Opens port given by GetName(). Uses default settings
                 or those defined by method Setup().
 Keywords:
Bool_t Close()
__________________________________________________________________[C++ CTOR]

 Name:           TMrbSerialComm::Close()
 Purpose:        Close connection
 Description:
 Keywords:
void Setup(Int_t BaudRate, Int_t NofDataBits = 8, TMrbSerialComm::EMrbParity Parity = kMrbParityNone, Int_t NofStopBits = 1, Bool_t UseRtsCts = kFALSE, Bool_t IgnoreCR = kTRUE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::Setup
 Purpose:        Set device parameters
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Stores device settings to be used with method Open().
 Keywords:
Int_t ReadData(TString& Data)
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::ReadData
 Purpose:        Read data from serial device
 Arguments:      TString & Data         -- where to store data
 Results:        Int_t NofBytes         -- number of bytes read
 Exceptions:
 Description:    Inputs data from serial port.
 Keywords:
Int_t WriteData(const Char_t* Data)
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::WriteData
 Purpose:        Write data to serial port
 Arguments:      Char_t * Data       -- where to get data from
 Results:        Int_t NofBytes      -- number of bytes written
 Exceptions:
 Description:    Outputs data to serial port.
 Keywords:
Int_t WriteSingleBytes(const Char_t* Data, Double_t Delay = -1)
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::WriteSingleBytes
 Purpose:        Write data to serial port
 Arguments:      Char_t * Data       -- where to get data from
                 Double_t Delay      -- delay in s to wait between chars
 Results:        Int_t NofBytes      -- number of bytes written
 Exceptions:
 Description:    Outputs data to serial port.
                 Writes single bytes waiting a certain delay in between
 Keywords:
Int_t WriteWithDelay(const Char_t* Data, Double_t Delay = -1)
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::WriteWithDelay
 Purpose:        Write data to serial port
 Arguments:      Char_t * Data       -- where to get data from
                 Double_t Delay      -- delay in s to wait
 Results:        Int_t NofBytes      -- number of bytes written
 Exceptions:
 Description:    Outputs data to serial port.
                 Waits a certain delay after output.
 Keywords:
void Print() const
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::Print
 Purpose:        Output settings to cout
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Outputs settings to cout.
 Keywords:
const Char_t * MakePrintable(TString& PrintString, const Char_t* String) const
________________________________________________________________[C++ METHOD]

 Name:           TMrbSerialComm::MakePrintable
 Purpose:        Convert unprintable chars to printable ones
 Arguments:      TString & PrintString    -- where to put printable output
                 Char_t * String          -- original string
 Results:        Char_t * PrintString     -- pointer to output string
 Exceptions:
 Description:    Converts a string: makes unprintable chars visible.
 Keywords:
TMrbSerialComm()
{}
TMrbSerialComm(const Char_t* Device)
virtual ~TMrbSerialComm()
{ this->Close(); }
void UseRtsCts(Bool_t Flag)
{ fUseRtsCts = Flag; }
void IgnoreCR(Bool_t Flag)
{ fIgnoreCR = Flag; }
void SetBaudRate(Int_t BaudRate)
{ fBaudRate = BaudRate; }
void SetBits(Int_t DataBits, Int_t StopBits)
{ fNofDataBits = DataBits; fNofStopBits = StopBits; }
void SetParity(TMrbSerialComm::EMrbParity Parity)
{ fParity = Parity; }
void SetDelay(Double_t Delay)
{ fDelay = Delay; }
void SetLineTerm1(Char_t Term)
{ fLineTerm1 = Term; }
void SetLineTerm2(Char_t Term)
{ fLineTerm2 = Term; }
void SetPrefix(const Char_t* Prefix)
{ fPrefix = Prefix; }
void SetPostfix(const Char_t* Postfix, Bool_t CrFlag = kTRUE)
{ fPostfix = Postfix; if (CrFlag) fPostfix += "\r"; }
const Char_t * GetPort() const
{ return(this->GetTitle()); }
Bool_t IsOpen() const
{ return(fFd != -1); }
void Print(Option_t* Option) const
{ TObject::Print(Option); }
void Help()
{ gSystem->Exec(Form("mrbHelp %s", this->ClassName())); }


Revision: $Id: TMrbSerialComm.h,v 1.7 2007/07/27 11:17:23 Rudolf.Lutter Exp $
ROOT page - Home page - Class index - Top of the page
This page has been automatically generated by use of ROOT's THtml class. If you have any comments or suggestions about the page layout send a mail to Marabou Support.