VTK  9.3.20240623
Classes | Public Member Functions | Protected Attributes | List of all members
vtkOStreamWrapper Class Reference

Wrapper for C++ ostream. More...

#include <vtkOStreamWrapper.h>

Inheritance diagram for vtkOStreamWrapper:
[legend]

Classes

struct  EndlType
 Type for a fake endl. More...
 

Public Member Functions

virtual ~vtkOStreamWrapper ()
 
vtkOStreamWrapperoperator<< (void(*)(void *))
 
vtkOStreamWrapperoperator<< (void *(*)(void *))
 
vtkOStreamWrapperoperator<< (int(*)(void *))
 
vtkOStreamWrapperoperator<< (int *(*)(void *))
 
vtkOStreamWrapperoperator<< (float *(*)(void *))
 
vtkOStreamWrapperoperator<< (const char *(*)(void *))
 
vtkOStreamWrapperoperator<< (void(*)(void *, int *))
 
template<template< typename, typename, typename > class S>
vtkOStreamWrapperoperator<< (const S< char, std::char_traits< char >, std::allocator< char > > &s)
 
template<typename T >
vtkOStreamWrapperoperator<< (const vtkSmartPointer< T > &ptr)
 
vtkOStreamWrapperwrite (const char *, unsigned long)
 Forward the write method to the real stream.
 
ostream & GetOStream ()
 Get a reference to the real ostream.
 
 operator ostream & ()
 Allow conversion to the real ostream type.
 
 operator int ()
 Forward conversion to bool to the real ostream.
 
void flush ()
 Forward the flush method to the real ostream.
 
 vtkOStreamWrapper (ostream &os)
 Construct class to reference a real ostream.
 
 vtkOStreamWrapper (vtkOStreamWrapper &r)
 Construct class to reference a real ostream.
 
vtkOStreamWrapperoperator<< (const EndlType &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (const vtkIndent &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (vtkObjectBase &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (const vtkLargeInteger &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (const vtkSmartPointerBase &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (const vtkStdString &)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (const char *)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (void *)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (char)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (short)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (int)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (long)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (long long)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (unsigned char)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (unsigned short)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (unsigned int)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (unsigned long)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (unsigned long long)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (float)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (double)
 Forward this output operator to the real ostream.
 
vtkOStreamWrapperoperator<< (bool)
 Forward this output operator to the real ostream.
 

Static Public Member Functions

static void UseEndl (const EndlType &)
 Implementation detail to allow macros to provide an endl that may or may not be used.
 

Protected Attributes

ostream & ostr
 

Detailed Description

Wrapper for C++ ostream.

Internal VTK use only.

Provides a wrapper around the C++ ostream so that VTK source files need not include the full C++ streams library. This is intended to prevent cluttering of the translation unit and speed up compilation. Experimentation has revealed between 10% and 60% less time for compilation depending on the platform. This wrapper is used by the macros in vtkSetGet.h.

Definition at line 33 of file vtkOStreamWrapper.h.

Constructor & Destructor Documentation

◆ vtkOStreamWrapper() [1/2]

vtkOStreamWrapper::vtkOStreamWrapper ( ostream &  os)

Construct class to reference a real ostream.

All methods and operators will be forwarded.

◆ vtkOStreamWrapper() [2/2]

vtkOStreamWrapper::vtkOStreamWrapper ( vtkOStreamWrapper r)

Construct class to reference a real ostream.

All methods and operators will be forwarded.

◆ ~vtkOStreamWrapper()

virtual vtkOStreamWrapper::~vtkOStreamWrapper ( )
virtual

Member Function Documentation

◆ operator<<() [1/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const EndlType )

Forward this output operator to the real ostream.

◆ operator<<() [2/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const vtkIndent )

Forward this output operator to the real ostream.

◆ operator<<() [3/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( vtkObjectBase )

Forward this output operator to the real ostream.

◆ operator<<() [4/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const vtkLargeInteger )

Forward this output operator to the real ostream.

◆ operator<<() [5/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const vtkSmartPointerBase )

Forward this output operator to the real ostream.

◆ operator<<() [6/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const vtkStdString )

Forward this output operator to the real ostream.

◆ operator<<() [7/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const char *  )

Forward this output operator to the real ostream.

◆ operator<<() [8/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( void *  )

Forward this output operator to the real ostream.

◆ operator<<() [9/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( char  )

Forward this output operator to the real ostream.

◆ operator<<() [10/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( short  )

Forward this output operator to the real ostream.

◆ operator<<() [11/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( int  )

Forward this output operator to the real ostream.

◆ operator<<() [12/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( long  )

Forward this output operator to the real ostream.

◆ operator<<() [13/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( long long  )

Forward this output operator to the real ostream.

◆ operator<<() [14/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( unsigned char  )

Forward this output operator to the real ostream.

◆ operator<<() [15/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( unsigned short  )

Forward this output operator to the real ostream.

◆ operator<<() [16/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( unsigned int  )

Forward this output operator to the real ostream.

◆ operator<<() [17/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( unsigned long  )

Forward this output operator to the real ostream.

◆ operator<<() [18/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( unsigned long long  )

Forward this output operator to the real ostream.

◆ operator<<() [19/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( float  )

Forward this output operator to the real ostream.

◆ operator<<() [20/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( double  )

Forward this output operator to the real ostream.

◆ operator<<() [21/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( bool  )

Forward this output operator to the real ostream.

◆ operator<<() [22/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( void(*)(void *)  )

◆ operator<<() [23/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( void *  *)(void *)

◆ operator<<() [24/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( int(*)(void *)  )

◆ operator<<() [25/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( int *  *)(void *)

◆ operator<<() [26/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( float *  *)(void *)

◆ operator<<() [27/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const char *  *)(void *)

◆ operator<<() [28/30]

vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( void(*)(void *, int *)  )

◆ operator<<() [29/30]

template<template< typename, typename, typename > class S>
vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const S< char, std::char_traits< char >, std::allocator< char > > &  s)
inline

Definition at line 104 of file vtkOStreamWrapper.h.

◆ operator<<() [30/30]

template<typename T >
vtkOStreamWrapper & vtkOStreamWrapper::operator<< ( const vtkSmartPointer< T > &  ptr)
inline

Definition at line 111 of file vtkOStreamWrapper.h.

◆ write()

vtkOStreamWrapper & vtkOStreamWrapper::write ( const char *  ,
unsigned long   
)

Forward the write method to the real stream.

◆ GetOStream()

ostream & vtkOStreamWrapper::GetOStream ( )

Get a reference to the real ostream.

◆ operator ostream &()

vtkOStreamWrapper::operator ostream & ( )

Allow conversion to the real ostream type.

This allows an instance of vtkOStreamWrapper to look like ostream when passing to a function argument.

◆ operator int()

vtkOStreamWrapper::operator int ( )

Forward conversion to bool to the real ostream.

◆ flush()

void vtkOStreamWrapper::flush ( )

Forward the flush method to the real ostream.

◆ UseEndl()

static void vtkOStreamWrapper::UseEndl ( const EndlType )
inlinestatic

Implementation detail to allow macros to provide an endl that may or may not be used.

Definition at line 149 of file vtkOStreamWrapper.h.

Member Data Documentation

◆ ostr

ostream& vtkOStreamWrapper::ostr
protected

Definition at line 153 of file vtkOStreamWrapper.h.


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