ATLAS Offline Software
Public Member Functions | List of all members
GenericResult Class Referenceabstract

the interface class for all HLT, CALIB, MONITORING results The class define the interface between PSC (PESA steering controllers) at Lvl2 and EF used to retrieve the information for processing in the Athena to be put in the (even or detector fragment) headers. More...

#include <GenericResult.h>

Inheritance diagram for GenericResult:
Collaboration diagram for GenericResult:

Public Member Functions

 GenericResult ()
 
virtual ~GenericResult ()
 
virtual bool accepted () const =0
 reject or accept More...
 
virtual bool error () const =0
 problems during processing More...
 
virtual uint32_t error_bits () const =0
 bit flags to explain problems during processing More...
 
virtual bool serialize (std::vector< uint32_t > &output)=0
 get the result of the processing as the raw vector of 32 bit unsigned integers More...
 
virtual bool serialize (uint32_t *&output, int &data_size, const int max_size=-1, const unsigned int mod_id=0)=0
 the optimized version of the above, works on plain C array the content is the same as in above More...
 
virtual bool deserialize (const std::vector< uint32_t > &source)=0
 unpacking raw result into the usable high level object More...
 
virtual bool deserialize (uint32_t *source, int data_size)=0
 more efficient version of above deserialize, using raw C arrays More...
 

Detailed Description

the interface class for all HLT, CALIB, MONITORING results The class define the interface between PSC (PESA steering controllers) at Lvl2 and EF used to retrieve the information for processing in the Athena to be put in the (even or detector fragment) headers.

Author
Tomas.nosp@m.z.Bo.nosp@m.ld@ce.nosp@m.rn.N.nosp@m.SPMPL.nosp@m.Sch

Definition at line 21 of file GenericResult.h.

Constructor & Destructor Documentation

◆ GenericResult()

GenericResult::GenericResult ( )
inline

Definition at line 23 of file GenericResult.h.

23 {}

◆ ~GenericResult()

virtual GenericResult::~GenericResult ( )
inlinevirtual

Definition at line 24 of file GenericResult.h.

24 {}

Member Function Documentation

◆ accepted()

virtual bool GenericResult::accepted ( ) const
pure virtual

reject or accept

Returns
true if event is accepted

Implemented in HLT::HLTResult.

◆ deserialize() [1/2]

virtual bool GenericResult::deserialize ( const std::vector< uint32_t > &  source)
pure virtual

unpacking raw result into the usable high level object

Parameters
sourceis a vector of serialized data
Returns
status of the operation

Implemented in HLT::HLTResult.

◆ deserialize() [2/2]

virtual bool GenericResult::deserialize ( uint32_t *  source,
int  data_size 
)
pure virtual

more efficient version of above deserialize, using raw C arrays

Parameters
sourcethe address in memory where the data start
data_sizeis the size of the C array storing the result

Implemented in HLT::HLTResult.

◆ error()

virtual bool GenericResult::error ( ) const
pure virtual

problems during processing

Returns
true if there was an error during event processing

Implemented in HLT::HLTResult.

◆ error_bits()

virtual uint32_t GenericResult::error_bits ( ) const
pure virtual

bit flags to explain problems during processing

Returns
some bits are set if there was na error

Implemented in HLT::HLTResult.

◆ serialize() [1/2]

virtual bool GenericResult::serialize ( std::vector< uint32_t > &  output)
pure virtual

get the result of the processing as the raw vector of 32 bit unsigned integers

Parameters
outputthe place where to put the data
Returns
status of the operation

Implemented in HLT::HLTResult.

◆ serialize() [2/2]

virtual bool GenericResult::serialize ( uint32_t *&  output,
int &  data_size,
const int  max_size = -1,
const unsigned int  mod_id = 0 
)
pure virtual

the optimized version of the above, works on plain C array the content is the same as in above

See also
serialize
Warning
the space allocated inside this function must freed by caller
Parameters
outputplace where the result will be stored
data_sizethe size of the used space of the output (not the allocated)
max_sizeis the maximum size the output can have, this is needed to handle Lvl2 limit for output size, -1 means no limit, and can be used by EF as well
mod_idis the rob module ID: this is used for data scouting events. mod_id = 0 means you are running on a full event.
Returns
status of the operation

Implemented in HLT::HLTResult.


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