KaliVeda
Toolkit for HIC analysis
Loading...
Searching...
No Matches
KVGeoStrucElement Class Reference

Detailed Description

Base class describing elements of array geometry.

Definition at line 18 of file KVGeoStrucElement.h.

#include <KVGeoStrucElement.h>

Inheritance diagram for KVGeoStrucElement:

Public Member Functions

 KVGeoStrucElement ()
 Default constructor.
 
 KVGeoStrucElement (const Char_t *name, const Char_t *type="")
 Create a geometry structure element with given name and type.
 
virtual ~KVGeoStrucElement ()
 Destructor.
 
virtual void Add (KVBase *)
 
void Clear (Option_t *opt="")
 Empty lists of detectors, daughter structures, and parent structures.
 
void ClearDetectors (const Char_t *type="")
 
void ClearStructures (const Char_t *type="")
 
virtual Bool_t Contains (KVBase *name) const
 
virtual Bool_t Fired (Option_t *opt="any") const
 
KVDetectorGetDetector (const Char_t *name) const
 Return detector in this structure with given name.
 
KVDetectorGetDetectorAny (const Char_t *name)
 
KVDetectorGetDetectorByType (const Char_t *type) const
 Return detector in this structure with given type.
 
KVSeqCollectionGetDetectorNameList (const Char_t *name) const
 
KVSeqCollectionGetDetectors ()
 
const KVSeqCollectionGetDetectors () const
 
KVSeqCollectionGetDetectorTypeList (const Char_t *type) const
 
const KVSeqCollectionGetParents () const
 
KVGeoStrucElementGetParentStructure (const Char_t *type, const Char_t *name="") const
 
KVGeoStrucElementGetStructure (const Char_t *name) const
 
KVGeoStrucElementGetStructure (const Char_t *type, const Char_t *name) const
 Get structure with type and name.
 
KVGeoStrucElementGetStructure (const Char_t *type, Int_t num) const
 Get structure with type and number.
 
const KVSeqCollectionGetStructures () const
 
KVSeqCollectionGetStructureTypeList (const Char_t *type) const
 
bool OwnsDaughters () const
 
bool OwnsDetectors () const
 
void Print (Option_t *option="") const
 
virtual void Remove (KVBase *)
 
void SetOwnsDaughters (Bool_t yes=kTRUE)
 
void SetOwnsDetectors (Bool_t yes=kTRUE)
 
void Sort (Bool_t order=kSortAscending)
 
void SortDetectors (Bool_t order=kSortAscending)
 
void SortStructures (Bool_t order=kSortAscending)
 
- Public Member Functions inherited from KVBase
 KVBase ()
 Default constructor.
 
 KVBase (const Char_t *name, const Char_t *title="")
 Ctor for object with given name and type.
 
 KVBase (const KVBase &)
 copy ctor
 
virtual ~KVBase ()
 
virtual void Copy (TObject &) const
 Make a copy of this object.
 
const Char_tGetLabel () const
 
UInt_t GetNumber () const
 
UInt_t GetNumberOfObjects () const
 
virtual TObjectGetObject () const
 
virtual const Char_tGetType () const
 
Bool_t HasLabel () const
 
virtual Bool_t IsCalled (const Char_t *name) const
 
Bool_t IsLabelled (const Char_t *l) const
 
virtual Bool_t IsType (const Char_t *typ) const
 
virtual void List ()
 
KVBaseoperator= (const KVBase &)
 copy assignment operator
 
Double_t ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const
 
void SetLabel (const Char_t *lab)
 
virtual void SetNumber (UInt_t num)
 
virtual void SetType (const Char_t *str)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 
void Clear (Option_t *option="") override
 
TObjectClone (const char *newname="") const override
 
Int_t Compare (const TObject *obj) const override
 
void Copy (TObject &named) const override
 
virtual void FillBuffer (char *&buffer)
 
const char * GetName () const override
 
const char * GetTitle () const override
 
ULong_t Hash () const override
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 
TNamedoperator= (const TNamed &rhs)
 
void Print (Option_t *option="") const override
 
virtual void SetName (const char *name)
 
virtual void SetNameTitle (const char *name, const char *title)
 
virtual void SetTitle (const char *title="")
 
virtual Int_t Sizeof () const
 
void Streamer (TBuffer &) override
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 
virtual ~TObject ()
 
void AbstractMethod (const char *method) const
 
virtual void AppendPad (Option_t *option="")
 
virtual void Browse (TBrowser *b)
 
ULong_t CheckedHash ()
 
virtual const char * ClassName () const
 
virtual void Delete (Option_t *option="")
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 
virtual void Draw (Option_t *option="")
 
virtual void DrawClass () const
 
virtual TObjectDrawClone (Option_t *option="") const
 
virtual void Dump () const
 
virtual void Error (const char *method, const char *msgfmt,...) const
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 
virtual TObjectFindObject (const char *name) const
 
virtual TObjectFindObject (const TObject *obj) const
 
virtual Option_tGetDrawOption () const
 
virtual const char * GetIconName () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 
virtual Bool_t HandleTimer (TTimer *timer)
 
Bool_t HasInconsistentHash () const
 
virtual void Info (const char *method, const char *msgfmt,...) const
 
virtual Bool_t InheritsFrom (const char *classname) const
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 
virtual void Inspect () const
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 
virtual Bool_t IsEqual (const TObject *obj) const
 
virtual Bool_t IsFolder () const
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 
virtual Bool_t Notify ()
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *vp)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, void *vp)
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 
virtual void Paint (Option_t *option="")
 
virtual void Pop ()
 
virtual Int_t Read (const char *name)
 
virtual void RecursiveRemove (TObject *obj)
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 
virtual void SetDrawOption (Option_t *option="")
 
virtual void SetUniqueID (UInt_t uid)
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 

Private Member Functions

void AddParentStructure (KVGeoStrucElement *)
 
void init ()
 Default initialisations.
 
void RemoveParentStructure (KVGeoStrucElement *)
 

Private Attributes

KVUniqueNameList fDetectors
 detectors in this structure element
 
KVUniqueNameList fParentStrucList
 parent structures
 
KVUniqueNameList fStructures
 daughter structures
 

Additional Inherited Members

- Public Types inherited from KVBase
enum  EKaliVedaBits { kIsKaliVedaObject = BIT(23) }
 
- Public Types inherited from TObject
enum  EDeprecatedStatusBits
 
enum  EStatusBits
 
- Static Public Member Functions inherited from KVBase
static Bool_t AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
 Comparison between two 64-bit floating-point values.
 
static void BackupFileWithDate (const Char_t *path)
 
static void CombineFiles (const Char_t *file1, const Char_t *file2, const Char_t *newfilename, Bool_t keep=kTRUE)
 
static void Deprecated (const char *method, const char *advice)
 
static Bool_t FindClassSourceFiles (const Char_t *class_name, KVString &imp_file, KVString &dec_file, const Char_t *dir_name=".")
 
static Bool_t FindExecutable (TString &exec, const Char_t *path="$(PATH)")
 
static const Char_tFindFile (const Char_t *search, TString &wfil)
 
static const Char_tGetBINDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetDATABASEFilePath ()
 
static const Char_tGetDATADIRFilePath (const Char_t *namefile="")
 
static Bool_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Bool_t defval)
 
static const Char_tGetDataSetEnv (const Char_t *dataset, const Char_t *type, const Char_t *defval)
 
static Double_t GetDataSetEnv (const Char_t *dataset, const Char_t *type, Double_t defval)
 
static const Char_tGetETCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetExampleFilePath (const Char_t *library, const Char_t *namefile)
 Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)
 
static const Char_tGetINCDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetKVBuildDate ()
 Returns KaliVeda build date.
 
static const Char_tGetKVBuildDir ()
 Returns top-level directory used for build.
 
static const Char_tGetKVBuildTime ()
 Returns KaliVeda build time.
 
static const Char_tGetKVBuildType ()
 Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)
 
static const Char_tGetKVBuildUser ()
 Returns username of person who performed build.
 
static const Char_tGetKVSourceDir ()
 Returns top-level directory of source tree used for build.
 
static const Char_tGetKVVersion ()
 Returns KaliVeda version string.
 
static const Char_tGetLIBDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetListOfPlugins (const Char_t *base)
 
static const Char_tGetListOfPluginURIs (const Char_t *base)
 
static const Char_tGetPluginURI (const Char_t *base, const Char_t *plugin)
 
static void GetTempFileName (TString &base)
 
static const Char_tGetTEMPLATEDIRFilePath (const Char_t *namefile="")
 
static const Char_tGetWORKDIRFilePath (const Char_t *namefile="")
 
static const Char_tgitBranch ()
 Returns git branch of sources.
 
static const Char_tgitCommit ()
 Returns last git commit of sources.
 
static void InitEnvironment ()
 
static bool is_gnuinstall ()
 
static Bool_t IsThisAPlugin (const TString &uri, TString &base)
 
static TPluginHandlerLoadPlugin (const Char_t *base, const Char_t *uri="0")
 
static Bool_t OpenContextMenu (const char *method, TObject *obj, const char *alt_method_name="")
 
static void OpenTempFile (TString &base, std::ofstream &fp)
 
static void PrintSplashScreen ()
 Prints welcome message and infos on version etc.
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, KVSQLite::database &dbfile, const Char_t *kvsubdir="")
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ifstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchAndOpenKVFile (const Char_t *name, std::ofstream &file, const Char_t *kvsubdir="", KVLockfile *locks=0)
 
static Bool_t SearchKVFile (const Char_t *name, TString &fullpath, const Char_t *kvsubdir="")
 
static const Char_tWorkingDirectory ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 
static Bool_t GetObjectStat ()
 
static void SetDtorOnly (void *obj)
 
static void SetObjectStat (Bool_t stat)
 
- Public Attributes inherited from TObject
 kBitMask
 
 kCanDelete
 
 kCannotPick
 
 kHasUUID
 
 kInconsistent
 
 kInvalidObject
 
 kIsOnHeap
 
 kIsReferenced
 
 kMustCleanup
 
 kNoContextMenu
 
 kNotDeleted
 
 kObjInCanvas
 
 kOverwrite
 
 kSingleKey
 
 kWriteDelete
 
 kZombie
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TObject
 kOnlyPrepStep
 

Constructor & Destructor Documentation

◆ KVGeoStrucElement() [1/2]

KVGeoStrucElement::KVGeoStrucElement ( )

Default constructor.

Definition at line 48 of file KVGeoStrucElement.cpp.

◆ KVGeoStrucElement() [2/2]

KVGeoStrucElement::KVGeoStrucElement ( const Char_t name,
const Char_t type = "" 
)

Create a geometry structure element with given name and type.

Definition at line 60 of file KVGeoStrucElement.cpp.

◆ ~KVGeoStrucElement()

KVGeoStrucElement::~KVGeoStrucElement ( )
virtual

Destructor.

Definition at line 71 of file KVGeoStrucElement.cpp.

Member Function Documentation

◆ Add()

void KVGeoStrucElement::Add ( KVBase element)
virtual

Add a detector or a daughter structure to this structure. Note that daughter structures are by defeault owned by their mother and will be deleted by her destructor. Call SetOwnsDaughters(kFALSE) to change. Detectors are not owned by default - call SetOwnsDetectors(kTRUE) to change.

Reimplemented in KVASGroup, KVRing, and KVTelescope.

Definition at line 135 of file KVGeoStrucElement.cpp.

◆ AddParentStructure()

void KVGeoStrucElement::AddParentStructure ( KVGeoStrucElement e)
private

Definition at line 29 of file KVGeoStrucElement.cpp.

◆ Clear()

void KVGeoStrucElement::Clear ( Option_t opt = "")
virtual

Empty lists of detectors, daughter structures, and parent structures.

Reimplemented from KVBase.

Reimplemented in KVMultiDetArray.

Definition at line 184 of file KVGeoStrucElement.cpp.

◆ ClearDetectors()

void KVGeoStrucElement::ClearDetectors ( const Char_t type = "")

Remove detectors of given type from this structure (default: all detectors) If they belong to the structure, they will be deleted.

Definition at line 83 of file KVGeoStrucElement.cpp.

◆ ClearStructures()

void KVGeoStrucElement::ClearStructures ( const Char_t type = "")

Remove daughter structures of given type from this structure (default: all detectors) If they belong to the structure, they will be deleted.

Definition at line 108 of file KVGeoStrucElement.cpp.

◆ Contains()

virtual Bool_t KVGeoStrucElement::Contains ( KVBase name) const
inlinevirtual

Returns kTRUE if this structure contains the detector or structure given as argument

Reimplemented in KVASGroup.

Definition at line 83 of file KVGeoStrucElement.h.

◆ Fired()

Bool_t KVGeoStrucElement::Fired ( Option_t opt = "any") const
virtual

Returns kTRUE if any detector or structure element in this structure has 'Fired' with the given option

Definition at line 316 of file KVGeoStrucElement.cpp.

◆ GetDetector()

KVDetector * KVGeoStrucElement::GetDetector ( const Char_t name) const

Return detector in this structure with given name.

Definition at line 239 of file KVGeoStrucElement.cpp.

◆ GetDetectorAny()

KVDetector * KVGeoStrucElement::GetDetectorAny ( const Char_t name)

Return detector in structure with given name. If not found in this structure, we look in all daughter structures for a detector with the name.

Definition at line 291 of file KVGeoStrucElement.cpp.

◆ GetDetectorByType()

KVDetector * KVGeoStrucElement::GetDetectorByType ( const Char_t type) const

Return detector in this structure with given type.

Definition at line 250 of file KVGeoStrucElement.cpp.

◆ GetDetectorNameList()

KVSeqCollection * KVGeoStrucElement::GetDetectorNameList ( const Char_t name) const

Create and fill a list with all detectors of given type in this structure. DELETE LIST AFTER USE - or, better: unique_ptr<KVSeqCollection> list(toto->GetDetectorNameList(...))

Definition at line 276 of file KVGeoStrucElement.cpp.

◆ GetDetectors() [1/2]

KVSeqCollection * KVGeoStrucElement::GetDetectors ( )
inline

Definition at line 113 of file KVGeoStrucElement.h.

◆ GetDetectors() [2/2]

const KVSeqCollection * KVGeoStrucElement::GetDetectors ( ) const
inline
Examples
ExampleRawAnalysis.cpp.

Definition at line 109 of file KVGeoStrucElement.h.

◆ GetDetectorTypeList()

KVSeqCollection * KVGeoStrucElement::GetDetectorTypeList ( const Char_t type) const

Create and fill a list with all detectors of given type in this structure. DELETE LIST AFTER USE - or, better: unique_ptr<KVSeqCollection> list(toto->GetDetectorTypeList(...))

Definition at line 262 of file KVGeoStrucElement.cpp.

◆ GetParents()

const KVSeqCollection * KVGeoStrucElement::GetParents ( ) const
inline

Definition at line 121 of file KVGeoStrucElement.h.

◆ GetParentStructure()

KVGeoStrucElement * KVGeoStrucElement::GetParentStructure ( const Char_t type,
const Char_t name = "" 
) const

Get parent geometry structure element of given type. Give unique name of structure if more than one element of same type is possible.

Definition at line 336 of file KVGeoStrucElement.cpp.

◆ GetStructure() [1/3]

KVGeoStrucElement * KVGeoStrucElement::GetStructure ( const Char_t name) const
inline

Return daughter structure with given name

Definition at line 93 of file KVGeoStrucElement.h.

◆ GetStructure() [2/3]

KVGeoStrucElement * KVGeoStrucElement::GetStructure ( const Char_t type,
const Char_t name 
) const

Get structure with type and name.

Definition at line 212 of file KVGeoStrucElement.cpp.

◆ GetStructure() [3/3]

KVGeoStrucElement * KVGeoStrucElement::GetStructure ( const Char_t type,
Int_t  num 
) const

Get structure with type and number.

Definition at line 198 of file KVGeoStrucElement.cpp.

◆ GetStructures()

const KVSeqCollection * KVGeoStrucElement::GetStructures ( ) const
inline

Definition at line 117 of file KVGeoStrucElement.h.

◆ GetStructureTypeList()

KVSeqCollection * KVGeoStrucElement::GetStructureTypeList ( const Char_t type) const

Create and fill a list with all structures of given type which are daughters of this structure. DELETE LIST AFTER USE - or, better: unique_ptr<KVSeqCollection> list(toto->GetStructureTypeList(...))

Definition at line 225 of file KVGeoStrucElement.cpp.

◆ init()

void KVGeoStrucElement::init ( void  )
private

Default initialisations.

Definition at line 16 of file KVGeoStrucElement.cpp.

◆ OwnsDaughters()

bool KVGeoStrucElement::OwnsDaughters ( ) const
inline

kTRUE: all daughter structures will be deleted by this kFALSE: daughter structures will not be deleted by this

Definition at line 48 of file KVGeoStrucElement.h.

◆ OwnsDetectors()

bool KVGeoStrucElement::OwnsDetectors ( ) const
inline

kTRUE: all detectors will be deleted by this kFALSE: detectors will not be deleted by this

Definition at line 55 of file KVGeoStrucElement.h.

◆ Print()

void KVGeoStrucElement::Print ( Option_t option = "") const
virtual

Reimplemented from KVBase.

Definition at line 355 of file KVGeoStrucElement.cpp.

◆ Remove()

void KVGeoStrucElement::Remove ( KVBase element)
virtual

Remove a detector or structure element from this structure User's responsibility to delete the detector or structure element.

Definition at line 161 of file KVGeoStrucElement.cpp.

◆ RemoveParentStructure()

void KVGeoStrucElement::RemoveParentStructure ( KVGeoStrucElement e)
private

Definition at line 38 of file KVGeoStrucElement.cpp.

◆ SetOwnsDaughters()

void KVGeoStrucElement::SetOwnsDaughters ( Bool_t  yes = kTRUE)
inline

yes = kTRUE: all daughter structures will be deleted by this yes = kFALSE: daughter structures will not be deleted by this

Definition at line 34 of file KVGeoStrucElement.h.

◆ SetOwnsDetectors()

void KVGeoStrucElement::SetOwnsDetectors ( Bool_t  yes = kTRUE)
inline

yes = kTRUE: all detectors will be deleted by this yes = kFALSE: detectors will not be deleted by this

Definition at line 41 of file KVGeoStrucElement.h.

◆ Sort()

void KVGeoStrucElement::Sort ( Bool_t  order = kSortAscending)
inline

Definition at line 62 of file KVGeoStrucElement.h.

◆ SortDetectors()

void KVGeoStrucElement::SortDetectors ( Bool_t  order = kSortAscending)
inline

Definition at line 71 of file KVGeoStrucElement.h.

◆ SortStructures()

void KVGeoStrucElement::SortStructures ( Bool_t  order = kSortAscending)
inline

Definition at line 67 of file KVGeoStrucElement.h.

Member Data Documentation

◆ fDetectors

KVUniqueNameList KVGeoStrucElement::fDetectors
private

detectors in this structure element

Definition at line 22 of file KVGeoStrucElement.h.

◆ fParentStrucList

KVUniqueNameList KVGeoStrucElement::fParentStrucList
private

parent structures

Definition at line 24 of file KVGeoStrucElement.h.

◆ fStructures

KVUniqueNameList KVGeoStrucElement::fStructures
private

daughter structures

Definition at line 23 of file KVGeoStrucElement.h.