adtf_file_library  0.13.1
Public Member Functions | List of all members
adtfdat_processing::Processor Class Referenceabstract

#include <processor.h>

Inheritance diagram for adtfdat_processing::Processor:
[legend]
Collaboration diagram for adtfdat_processing::Processor:
[legend]

Public Member Functions

virtual std::string getProcessorIdentifier () const =0
 
virtual bool isCompatible (const adtf_file::Stream &stream) const =0
 
virtual void open (const std::vector< adtf_file::Stream > &streams, const std::string &destination_url)=0
 
virtual void process (const adtf_file::FileItem &item)=0
 
- Public Member Functions inherited from adtf_file::Configurable
virtual ~Configurable ()=default
 DTOR.
 
virtual const ConfigurationgetConfiguration () const
 
virtual void setConfiguration (const Configuration &configuration)
 

Detailed Description

A processor handles incoming stream types, sample and triggers. This class Processor supports one or more streams. If only one Stream is supported use the adtfdat_processing::SingleStreamProcessor base class.

Member Function Documentation

◆ getProcessorIdentifier()

virtual std::string adtfdat_processing::Processor::getProcessorIdentifier ( ) const
pure virtual
Returns
The name of processor implementation.

◆ isCompatible()

virtual bool adtfdat_processing::Processor::isCompatible ( const adtf_file::Stream stream) const
pure virtual

This is called to check, whether a processor can handle a given stream.

◆ open()

virtual void adtfdat_processing::Processor::open ( const std::vector< adtf_file::Stream > &  streams,
const std::string &  destination_url 
)
pure virtual

Opens the processor for handling subsequent items from the given streams.

Remarks
If only one Stream is supported use the SingleStreamProcessor base class.
Parameters
[in]streamsThe streams.
[in]destination_urlThe output url, i.e. a filename.
Remarks
The Processor class is an interface where implementation should at least throw following exceptions in case of error:
Exceptions
std::exceptionbased exception with detailed description for implementation dependent error case for the open call

Implemented in adtfdat_processing::SingleStreamProcessor.

◆ process()

virtual void adtfdat_processing::Processor::process ( const adtf_file::FileItem item)
pure virtual

This is called for every item of the streams.

Parameters
[in]itemThe next item of one of the opened streams.

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

Copyright © CARIAD SE.
Generated on Fri Apr 19 2024 by doxygen 1.9.1
GIT Commit Hash: 82d535f82776c20b12fc60740bdae991b62444a7