Public Types | Public Member Functions | Private Member Functions | List of all members
lanelet::io_handlers::Writer Class Referenceabstract

Base object for writers. To create a new writer, you have to do the following steps: More...

#include <Writer.h>

Inheritance diagram for lanelet::io_handlers::Writer:
Inheritance graph
[legend]

Public Types

using Ptr = std::shared_ptr< Writer >
 
- Public Types inherited from lanelet::io_handlers::IOHandler
using Ptr = std::shared_ptr< IOHandler >
 

Public Member Functions

 IOHandler ()=default
 
 IOHandler (const Projector &projector, const io::Configuration &config=io::Configuration())
 
virtual void write (const std::string &filename, const LaneletMap &laneletMap, ErrorMessages &errors, const io::Configuration &params=io::Configuration()) const =0
 
 Writer ()=default
 
- Public Member Functions inherited from lanelet::io_handlers::IOHandler
io::Configuration config ()
 
 IOHandler (const Projector &projector, const io::Configuration &config=io::Configuration())
 
const Projectorprojector () const
 
virtual ~IOHandler ()=default
 

Private Member Functions

void handleDefaultProjector () const final
 using a default projector is not allowed. The implementations define how this issue is handled. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from lanelet::io_handlers::IOHandler
static constexpr const char * extension ()
 returns the extension supported by this parser More...
 
static constexpr const char * name ()
 returns the name of this handler. Must not be empty for child classes More...
 
- Protected Member Functions inherited from lanelet::io_handlers::IOHandler
 IOHandler ()=default
 

Detailed Description

Base object for writers. To create a new writer, you have to do the following steps:

  1. Inherit from this writer
  2. Overload the parse()-function, the name()-function (from IOHandler) and optionally the extension()-function (from IOHandler)
  3. Inherit the constructors (using Writer::Writer)
  4. register your writer using the Registerwriter object

Definition at line 22 of file Writer.h.

Member Typedef Documentation

◆ Ptr

using lanelet::io_handlers::Writer::Ptr = std::shared_ptr<Writer>

Definition at line 26 of file Writer.h.

Constructor & Destructor Documentation

◆ Writer()

lanelet::io_handlers::Writer::Writer ( )
default

Member Function Documentation

◆ handleDefaultProjector()

void lanelet::io_handlers::Writer::handleDefaultProjector ( ) const
inlinefinalprivatevirtual

using a default projector is not allowed. The implementations define how this issue is handled.

Implements lanelet::io_handlers::IOHandler.

Definition at line 33 of file Writer.h.

◆ IOHandler() [1/2]

lanelet::io_handlers::IOHandler::IOHandler
default

◆ IOHandler() [2/2]

lanelet::io_handlers::IOHandler::IOHandler
inlineexplicit

Definition at line 16 of file IoHandler.h.

◆ write()

virtual void lanelet::io_handlers::Writer::write ( const std::string &  filename,
const LaneletMap laneletMap,
ErrorMessages errors,
const io::Configuration params = io::Configuration() 
) const
pure virtual

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


lanelet2_io
Author(s): Fabian Poggenhans
autogenerated on Thu Mar 6 2025 03:26:03