|
GammaWare
Head Version for release 0.9
|
|
|
GammaWare
Head Version for release 0.9
|
|
Base class for a CompositeFrame. More...
#include <CompositeFrame.h>
Public Member Functions | |
| virtual Bool_t | AddSubFrame (const Frame &) |
| Add a subframe to that frame (only if composite) More... | |
| virtual void | ClearFrameStatus () |
| To clear to kGood the current status of this frame. More... | |
| virtual Bool_t | Configure (const char *name, const char *option) |
| configuration from/to a file More... | |
| virtual Bool_t | Configure (ConfigurationFrame *, const char *option) |
| to reconfigure the interface for that frame More... | |
| virtual Bool_t | Copy (const Char_t *buf, UInt_t size, const char opt= 'b') |
| copy a buffer to this Frame More... | |
| virtual Bool_t | Copy (const Frame *) |
| copy the content of a Frame into this one More... | |
| virtual void | Dump (const Char_t *filename, Bool_t anew=false) const |
| Dump the content of the frame in a file (for debugging) More... | |
| virtual Bool_t | Dump (FILE *) const |
| virtual Bool_t | Export (BufferIO &buf) const |
| Export the content of the frame in a buffer. More... | |
| virtual Bool_t | ExportData (BufferIO &buf) const |
| Export the content of the frame (data part only) in a buffer. More... | |
| virtual void | FastReset () |
| FastReset the current frame, means the data part keep the previous values. More... | |
| virtual Short_t | GetCheckLevel () const |
| virtual BaseBuffer::EStatus | GetFrameStatus () const |
| To get the current status of this frame. More... | |
| virtual Key * | GetKey () |
| To get the Key associated to this frame. More... | |
| virtual const Key * | GetKey () const |
| To get the Key associated to this frame. More... | |
| virtual UInt_t | GetLength () const |
| total length for that frame More... | |
| virtual UInt_t | GetNbSubFrame () const |
| Returns the number of sub-frames composing this frame. Scan have to be called first. More... | |
| virtual const BufferIO * | GetRealBuffer () const |
| give access to the underlying buffer of the data part More... | |
| const FactoryItem & | GetSignature () const |
| Signature of that frame. More... | |
| virtual const Key * | GetSubKey (UInt_t which) const |
| to get one of the key composing the buffer. if out of range, return the main key More... | |
| virtual Bool_t | IsASubFrame (const Frame &) |
| to check if a subframe could be added to the composite frame More... | |
| virtual Bool_t | IsComposite () const |
| tells if this frame is a composite frame i.e. if it is composed of sub-frames More... | |
| virtual Bool_t | IsLinked () const |
| true if the underlying buffers have been linked. More... | |
| virtual Bool_t | Link (const BufferIO &, UInt_t, const char= 'b')=0 |
| Link a buffer to this Frame. More... | |
| virtual Bool_t | Link (const Char_t *buf, UInt_t size, const char opt= 'b') |
| Link a buffer to this Frame. More... | |
| virtual Bool_t | Link (const BufferIO &buf, UInt_t pos, const Char_t opt= 'b') |
| copy a buffer to this Frame More... | |
| virtual Bool_t | Link (const Frame *) |
| Link a frame into this one. They have to have the same prototype. More... | |
| virtual Bool_t | LinkSubFrame (UInt_t, Frame *) |
| Attach the sub-frame corresponding to the given subkey to the Frame given in the second argument. More... | |
| virtual Bool_t | Load (FILE *) |
| load a Frame from a C file (for debugging) - return the number of bytes read More... | |
| virtual UInt_t | Read () |
| Reads from the CompositeFrame the content into dedicated structures. More... | |
| virtual void | Reset () |
| Reset the current frame. More... | |
| virtual UInt_t | Scan () |
| Scan this CompositeFrame. If it is a composite frame, it looks for the keys of sub-frames. More... | |
| virtual void | SetCheckLevel (Short_t checklevel) |
| The number of tests (and the speed !) once writing/reading in Frame increase with this level. More... | |
| virtual void | Stallion (UInt_t repetition=4u) |
| Fill the frame with a given pattern (used for debugging) More... | |
| virtual Bool_t | TransfertSubFrame (const Frame &from, UInt_t whichsub) |
| copy the sub-frame #i to the CompositeFrame given in the second argument More... | |
| virtual void | Unlink () |
| Copy a buffer to this Frame. More... | |
| virtual UInt_t | Write () |
| It writes to the Frame the content of the dedicated structures. More... | |
| virtual | ~CompositeFrame () |
Protected Member Functions | |
| CompositeFrame (Key *) | |
| CompositeFrame (Key *, const FactoryItem &) | |
| virtual Bool_t | CopyFrame (const Char_t *buf, UInt_t size) |
| virtual Bool_t | CopyKey (const Char_t *buf, UInt_t size) |
| virtual Bool_t | DoConfigure (std::istream &) |
| configure this from an input stream More... | |
| virtual Bool_t | DoConfigure (std::ostream &) |
| write the configuration in an output stream More... | |
| virtual Bool_t | LinkFrame (const Char_t *buf, UInt_t size) |
| virtual Bool_t | LinkKey (const Char_t *buf, UInt_t size) |
| Key * | NewSubKey () |
| to get a new subkey More... | |
| virtual BufferIO * | RealBuffer () |
| void | SetSignature (FactoryItem item) |
| to change the signature of that frame More... | |
Protected Attributes | |
| BufferIO * | fBuffer |
| Key * | fKey |
| Key * | fSubKey |
| Key used to scan the main frame (link to parts of the main frame) More... | |
| Key * | fSubKeyConst |
| ConstKey remains unchanged (unlinked) to be sure the comparison IsAKey is always good. More... | |
Base class for a CompositeFrame.
A composite Frame is a frame composed of sub-frames. Thus, this interface proposes methods to manipulate such sub-frames (access, extraction, add etc ..)
As a Frame, a composite frame starts with a Key. A second Key characterises a composite frame since all sub-frames in it start with this second key type. Of course, the same kind of key could be used in both cases. That is why two constructors are provided for classes that inherits from CompositeFrame:
If only one key is given in the constructor,
Definition at line 52 of file CompositeFrame.h.
1.8.7