Assimp  v4.1. (December 2018)
IOStreamBase Class Reference

This class represents the stream to write out. More...

Public Member Functions

virtual bool close ()
 Will close the stream. More...
 
 IOStreamBase (StreamFormatterBase *formatter=ddl_nullptr)
 The class constructor with the formatter. More...
 
virtual bool isOpen () const
 Returns true, if the stream is open. More...
 
virtual bool open (const std::string &name)
 Will open the stream. More...
 
virtual size_t read (size_t sizeToRead, std::string &statement)
 Will read a string from the stream. More...
 
virtual size_t write (const std::string &statement)
 Will write a string into the stream. More...
 
virtual ~IOStreamBase ()
 The class destructor, virtual. More...
 

Detailed Description

This class represents the stream to write out.

Constructor & Destructor Documentation

◆ IOStreamBase()

IOStreamBase::IOStreamBase ( StreamFormatterBase formatter = ddl_nullptr)
explicit

The class constructor with the formatter.

Parameters
formatter[in] The formatter to use.

◆ ~IOStreamBase()

IOStreamBase::~IOStreamBase ( )
virtual

The class destructor, virtual.

Member Function Documentation

◆ close()

bool IOStreamBase::close ( )
virtual

Will close the stream.

Returns
true, if the stream was closed successfully, false if not.

◆ isOpen()

bool IOStreamBase::isOpen ( ) const
virtual

Returns true, if the stream is open.

Returns
true, if the stream is open, false if not.

◆ open()

bool IOStreamBase::open ( const std::string &  name)
virtual

Will open the stream.

Parameters
name[in] The name for the stream.
Returns
true, if the stream was opened successfully, false if not.

◆ read()

size_t IOStreamBase::read ( size_t  sizeToRead,
std::string &  statement 
)
virtual

Will read a string from the stream.

Parameters
sizeToRead[in] The size to read in bytes.
statement[out] The read statements.
Returns
The bytes read from the stream.

◆ write()

size_t IOStreamBase::write ( const std::string &  statement)
virtual

Will write a string into the stream.

Parameters
statement[in] The string to write.
Returns
The bytes written into the stream.

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