Assimp v5.2.2 (January 2022)
The Asset-Importer-Lib API documentation.
Assimp::LogStream Class Referenceabstract

CPP-API: Abstract interface for log stream implementations. More...

#include <LogStream.hpp>

Inherits Intern::AllocateFromAssimpHeap.

Public Member Functions

virtual void write (const char *message)=0
 Overwrite this for your own output methods. More...
 
virtual ~LogStream ()
 Virtual destructor
More...
 

Static Public Member Functions

static LogStreamcreateDefaultStream (aiDefaultLogStream stream, const char *name="AssimpLog.txt", IOSystem *io=nullptr)
 Creates a default log stream. More...
 

Protected Member Functions

 LogStream () AI_NO_EXCEPT
 Default constructor. More...
 

Detailed Description

CPP-API: Abstract interface for log stream implementations.

Several default implementations are provided, see aiDefaultLogStream for more details. Writing your own implementation of LogStream is just necessary if these are not enough for your purpose.

Constructor & Destructor Documentation

◆ LogStream()

Assimp::LogStream::LogStream ( )
inlineprotecteddefault

Default constructor.

◆ ~LogStream()

Assimp::LogStream::~LogStream ( )
inlinevirtualdefault

Virtual destructor

Member Function Documentation

◆ createDefaultStream()

static LogStream * Assimp::LogStream::createDefaultStream ( aiDefaultLogStream  stream,
const char *  name = "AssimpLog.txt",
IOSystem io = nullptr 
)
static

Creates a default log stream.

Parameters
streamsType of the default stream
nameFor aiDefaultLogStream_FILE: name of the output file
ioFor aiDefaultLogStream_FILE: IOSystem to be used to open the output file. Pass nullptr for the default implementation.
Returns
New LogStream instance.

◆ write()

virtual void Assimp::LogStream::write ( const char *  message)
pure virtual

Overwrite this for your own output methods.

Log messages may consist of multiple lines and you shouldn't expect a consistent formatting. If you want custom formatting (e.g. generate HTML), supply a custom instance of Logger to #DefaultLogger:set(). Usually you can expect that a log message is exactly one line and terminated with a single
character.

Parameters
messageMessage to be written

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