ViewHelper Namespace Reference

Classes
class	ViewMerger

Functions
template<typename T >
StatusCode	makeAndPopulate (std::string const &viewNameRoot, ViewContainer *viewVector, SG::WriteHandleKey< T > const &populateKey, EventContext const &sourceContext, std::vector< T > const &inputData, bool const allowFallThrough=true)
StatusCode	scheduleSingleView (SG::View *view, std::string const &nodeName, EventContext const &sourceContext, EventIDBase::number_type conditionsRun, SmartIF< IScheduler > scheduler)
StatusCode	scheduleViews (ViewContainer *viewVector, std::string const &nodeName, EventContext const &sourceContext, SmartIF< IScheduler > scheduler, bool reverseOrder=false)
SG::View *	makeView (const std::string &common_name, int const unique_index=-1, bool const allowFallThrough=true)
template<typename T >
SG::ReadHandle< T >	makeHandle (const SG::View *view, const SG::ReadHandleKey< T > &rhKey, const EventContext &context)
	navigate from the TrigComposite to nearest view and fetch object from it More...
template<typename T >
ElementLink< T >	makeLink (const SG::View *view, const SG::ReadHandle< T > &handle, size_t index)
	Create EL to a collection in view. More...

Function Documentation

makeAndPopulate()

template<typename T >

StatusCode ViewHelper::makeAndPopulate ( std::string const &  viewNameRoot, ViewContainer *  viewVector, SG::WriteHandleKey< T > const &  populateKey, EventContext const &  sourceContext, std::vector< T > const &  inputData, bool const  allowFallThrough = true  )

inline

Definition at line 24 of file ViewHelper.h.

  {
    //Check for spaces in the name
    if ( viewNameRoot.find( ' ' ) != std::string::npos )
    {
      return StatusCode::FAILURE;
    }
 
    //Make a WriteHandle to use
    SG::WriteHandle<T> populateHandle( populateKey, sourceContext );
 
    //Loop over all input data
    unsigned int const viewNumber = inputData.size();
    for ( unsigned int viewIndex = 0; viewIndex < viewNumber; ++viewIndex )
    {
      //Create view
      SG::View * outputView = new SG::View( viewNameRoot, viewIndex, allowFallThrough );
      viewVector->push_back( outputView );
 
      //Attach a handle to the view
      StatusCode sc = populateHandle.setProxyDict( outputView );
      if ( !sc.isSuccess() )
      {
        viewVector->clear();
        return sc;
      }
 
      //Populate the view
      sc = populateHandle.record( std::make_unique< T >( inputData[ viewIndex ] ) );
      if ( !sc.isSuccess() )
      {
        viewVector->clear();
        return sc;
      }
    }
 
    return StatusCode::SUCCESS;
  }

makeHandle()

template<typename T >

SG::ReadHandle<T> ViewHelper::makeHandle	(	const SG::View *	view,
		const SG::ReadHandleKey< T > &	rhKey,
		const EventContext &	context
	)

navigate from the TrigComposite to nearest view and fetch object from it

Returns

handle (can be invalid)

Definition at line 258 of file ViewHelper.h.

  {
    SG::View* nview ATLAS_THREAD_SAFE = const_cast< SG::View* >( view ); //We need it until reading from const IProxyDict is supported
 
    auto handle = SG::makeHandle( rhKey, context );
    if ( handle.setProxyDict( nview ).isFailure() ) {
      //We ignore it because the handle will be invalid anyway if this call is unsuccessful
      throw std::runtime_error( "Can't make ReadHandle of key " + rhKey.key() + " type " + ClassID_traits<T>::typeName() + " in view " + view->name() );
    }
    return handle;
  }

makeLink()

template<typename T >

ElementLink<T> ViewHelper::makeLink	(	const SG::View *	view,
		const SG::ReadHandle< T > &	handle,
		size_t	index
	)

Create EL to a collection in view.

Warning

no checks are made as to the validity of the created EL

Definition at line 276 of file ViewHelper.h.

  {
    auto proxy = view->proxy( handle.clid(), handle.key() );
    if ( proxy == nullptr ) throw std::runtime_error( "Attempting to make element link with invalid key " + handle.key() );
    return ElementLink<T>( proxy->name(), index );
  }

makeView()

SG::View* ViewHelper::makeView ( const std::string &  common_name, int const  unique_index = -1, bool const  allowFallThrough = true  )

inline

• unique_index - gets appended to the view name if >= 0

Definition at line 241 of file ViewHelper.h.

  {
    //Check for spaces in the name
    if ( common_name.find( ' ' ) != std::string::npos )
    {
      return nullptr;
    }
 
    return new SG::View( common_name, unique_index, allowFallThrough );
  }

scheduleSingleView()

StatusCode ViewHelper::scheduleSingleView ( SG::View *  view, std::string const &  nodeName, EventContext const &  sourceContext, EventIDBase::number_type  conditionsRun, SmartIF< IScheduler >  scheduler  )

inline

Definition at line 66 of file ViewHelper.h.

  {
    //Make a new context with the view attached
    auto viewContext = std::make_unique< EventContext >( sourceContext );
    if ( view->getROI().isValid() ) {
      Atlas::setExtendedEventContext( *viewContext,
                                      Atlas::ExtendedEventContext( view, conditionsRun, *view->getROI() ) );
    } else {
      Atlas::setExtendedEventContext( *viewContext,
                                      Atlas::ExtendedEventContext( view, conditionsRun ) );
    }
 
    //Attach the view to the named node
    return scheduler->scheduleEventView( &sourceContext, nodeName, std::move( viewContext ) );
  }

scheduleViews()

StatusCode ViewHelper::scheduleViews ( ViewContainer *  viewVector, std::string const &  nodeName, EventContext const &  sourceContext, SmartIF< IScheduler >  scheduler, bool  reverseOrder = false  )

inline

Definition at line 84 of file ViewHelper.h.

  {
    //Require the information of the extended context (should always be there, but check anyway)
    if ( !Atlas::hasExtendedEventContext( sourceContext ) ) {
      return StatusCode::FAILURE;
    }
    Atlas::ExtendedEventContext const extendedContext = Atlas::getExtendedEventContext( sourceContext );
 
    //Prevent view nesting - test if source context has view attached
    if ( dynamic_cast< SG::View* >( extendedContext.proxy() ) ) {
      return StatusCode::FAILURE;
    }
 
    //Retrieve the scheduler
    if ( !scheduler ) {
      return StatusCode::FAILURE;
    }
 
    if ( viewVector->empty() ) {
 
      //Disable the node if no views
      return scheduler->scheduleEventView( &sourceContext, nodeName, 0 );
    }
    else {
      if ( reverseOrder ) {
        for ( auto iter = viewVector->rbegin(); iter != viewVector->rend(); ++iter ) {
 
          //Schedule each view in reverse (should make no difference, just a debugging tool)
          if ( scheduleSingleView( *iter, nodeName, sourceContext,
                                   extendedContext.conditionsRun(), scheduler ).isFailure() ) {
            return StatusCode::FAILURE;
          }
        }
      }
      else {
        for ( SG::View* view : *viewVector ) {
 
          //Schedule each view
          if ( scheduleSingleView( view, nodeName, sourceContext,
                                   extendedContext.conditionsRun(), scheduler ).isFailure() ) {
            return StatusCode::FAILURE;
          }
        }
      }
    }
 
    return StatusCode::SUCCESS;
  }