DD4hep  1.30.0
Detector Description Toolkit for High Energy Physics
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
dd4hep::align::GlobalAlignmentStack Class Reference

Alignment Stack object definition. More...

#include <GlobalAlignmentStack.h>

Classes

class  StackEntry
 Stack entry definition. More...
 

Public Types

enum  Flags {
  OVERLAP_DEFINED = 1<<20, MATRIX_DEFINED = 1<<21, CHECKOVL_DEFINED = 1<<22, CHECKOVL_VALUE = 1<<23,
  RESET_VALUE = 1<<24, RESET_CHILDREN = 1<<25, ____LLLAST = 1<<31
}
 
typedef std::map< std::string, StackEntry * > Stack
 

Public Member Functions

virtual ~GlobalAlignmentStack ()
 Default destructor. Careful with this one: More...
 
bool insert (const std::string &full_path, dd4hep_ptr< StackEntry > &new_entry)
 Add a new entry to the cache. The key is the placement path. More...
 
bool insert (dd4hep_ptr< StackEntry > &new_entry)
 Add a new entry to the cache. The key is the placement path. The placement path must be set in the entry. More...
 
void release ()
 Clear data content and remove the slignment stack. More...
 
size_t size () const
 Access size of the alignment stack. More...
 
bool add (dd4hep_ptr< StackEntry > &new_entry)
 Add a new entry to the cache. The key is the placement path. More...
 
dd4hep_ptr< StackEntrypop ()
 Retrieve an alignment entry of the current stack. More...
 
std::vector< const StackEntry * > entries () const
 Get all path entries to be aligned. Note: transient! More...
 

Static Public Member Functions

static GlobalAlignmentStackget ()
 Static client accessor. More...
 
static void create ()
 Create an alignment stack instance. The creation of a second instance will be refused. More...
 
static bool exists ()
 Check existence of alignment stack. More...
 
static bool overlapDefined (const StackEntry &e)
 Check if the overlap flag checking is enabled. More...
 
static bool checkOverlap (const StackEntry &e)
 Check if the overlap flag checking is enabled. More...
 
static bool overlapValue (const StackEntry &e)
 Check if the overalp value is present. More...
 
static bool hasMatrix (const StackEntry &e)
 Check if this alignment entry has a non unitary transformation matrix. More...
 
static bool needsReset (const StackEntry &e)
 Check flag if the node location should be reset. More...
 
static bool resetChildren (const StackEntry &e)
 Check flag if the node location and all children should be reset. More...
 

Protected Member Functions

 GlobalAlignmentStack ()
 Default constructor. More...
 

Protected Attributes

Stack m_stack
 The subdetector specific map of alignments caches. More...
 

Detailed Description

Alignment Stack object definition.

Author
M.Frank
Version
1.0

Definition at line 34 of file GlobalAlignmentStack.h.

Member Typedef Documentation

◆ Stack

typedef std::map<std::string, StackEntry*> dd4hep::align::GlobalAlignmentStack::Stack

Definition at line 100 of file GlobalAlignmentStack.h.

Member Enumeration Documentation

◆ Flags

Enumerator
OVERLAP_DEFINED 
MATRIX_DEFINED 
CHECKOVL_DEFINED 
CHECKOVL_VALUE 
RESET_VALUE 
RESET_CHILDREN 
____LLLAST 

Definition at line 36 of file GlobalAlignmentStack.h.

Constructor & Destructor Documentation

◆ GlobalAlignmentStack()

GlobalAlignmentStack::GlobalAlignmentStack ( )
protected

Default constructor.

Definition at line 83 of file GlobalAlignmentStack.cpp.

◆ ~GlobalAlignmentStack()

GlobalAlignmentStack::~GlobalAlignmentStack ( )
virtual

Default destructor. Careful with this one:

Default destructor.

Definition at line 89 of file GlobalAlignmentStack.cpp.

Member Function Documentation

◆ add()

bool GlobalAlignmentStack::add ( dd4hep_ptr< StackEntry > &  new_entry)

Add a new entry to the cache. The key is the placement path.

Definition at line 139 of file GlobalAlignmentStack.cpp.

◆ checkOverlap()

static bool dd4hep::align::GlobalAlignmentStack::checkOverlap ( const StackEntry e)
inlinestatic

Check if the overlap flag checking is enabled.

Definition at line 123 of file GlobalAlignmentStack.h.

◆ create()

void GlobalAlignmentStack::create ( )
static

Create an alignment stack instance. The creation of a second instance will be refused.

Definition at line 102 of file GlobalAlignmentStack.cpp.

◆ entries()

std::vector< const GlobalAlignmentStack::StackEntry * > GlobalAlignmentStack::entries ( ) const

Get all path entries to be aligned. Note: transient!

Get all pathes to be aligned.

Definition at line 173 of file GlobalAlignmentStack.cpp.

◆ exists()

bool GlobalAlignmentStack::exists ( )
static

Check existence of alignment stack.

Definition at line 110 of file GlobalAlignmentStack.cpp.

◆ get()

GlobalAlignmentStack & GlobalAlignmentStack::get ( )
static

Static client accessor.

Definition at line 95 of file GlobalAlignmentStack.cpp.

◆ hasMatrix()

static bool dd4hep::align::GlobalAlignmentStack::hasMatrix ( const StackEntry e)
inlinestatic

Check if this alignment entry has a non unitary transformation matrix.

Definition at line 127 of file GlobalAlignmentStack.h.

◆ insert() [1/2]

bool GlobalAlignmentStack::insert ( const std::string &  full_path,
dd4hep_ptr< StackEntry > &  new_entry 
)

Add a new entry to the cache. The key is the placement path.

Definition at line 124 of file GlobalAlignmentStack.cpp.

◆ insert() [2/2]

bool GlobalAlignmentStack::insert ( dd4hep_ptr< StackEntry > &  new_entry)

Add a new entry to the cache. The key is the placement path. The placement path must be set in the entry.

Add a new entry to the cache. The key is the placement path.

Definition at line 134 of file GlobalAlignmentStack.cpp.

◆ needsReset()

static bool dd4hep::align::GlobalAlignmentStack::needsReset ( const StackEntry e)
inlinestatic

Check flag if the node location should be reset.

Definition at line 129 of file GlobalAlignmentStack.h.

◆ overlapDefined()

static bool dd4hep::align::GlobalAlignmentStack::overlapDefined ( const StackEntry e)
inlinestatic

Check if the overlap flag checking is enabled.

Definition at line 121 of file GlobalAlignmentStack.h.

◆ overlapValue()

static bool dd4hep::align::GlobalAlignmentStack::overlapValue ( const StackEntry e)
inlinestatic

Check if the overalp value is present.

Definition at line 125 of file GlobalAlignmentStack.h.

◆ pop()

dd4hep::dd4hep_ptr< GlobalAlignmentStack::StackEntry > GlobalAlignmentStack::pop ( )

Retrieve an alignment entry of the current stack.

Definition at line 160 of file GlobalAlignmentStack.cpp.

◆ release()

void GlobalAlignmentStack::release ( )

Clear data content and remove the slignment stack.

Definition at line 115 of file GlobalAlignmentStack.cpp.

◆ resetChildren()

static bool dd4hep::align::GlobalAlignmentStack::resetChildren ( const StackEntry e)
inlinestatic

Check flag if the node location and all children should be reset.

Definition at line 131 of file GlobalAlignmentStack.h.

◆ size()

size_t dd4hep::align::GlobalAlignmentStack::size ( ) const
inline

Access size of the alignment stack.

Definition at line 140 of file GlobalAlignmentStack.h.

Member Data Documentation

◆ m_stack

Stack dd4hep::align::GlobalAlignmentStack::m_stack
protected

The subdetector specific map of alignments caches.

Definition at line 104 of file GlobalAlignmentStack.h.


The documentation for this class was generated from the following files: