VTK  9.3.20240328
Public Member Functions | Protected Attributes | List of all members
vtkOStrStreamWrapper Class Reference

Wrapper for ostrstream. More...

#include <vtkOStrStreamWrapper.h>

Inheritance diagram for vtkOStrStreamWrapper:
[legend]
Collaboration diagram for vtkOStrStreamWrapper:
[legend]

Public Member Functions

 vtkOStrStreamWrapper ()
 Constructor. More...
 
 ~vtkOStrStreamWrapper () override
 Destructor frees all used memory. More...
 
char * str ()
 Get the string that has been written. More...
 
vtkOStrStreamWrapperrdbuf ()
 Returns a pointer to this class. More...
 
void freeze ()
 Set whether the memory is frozen. More...
 
void freeze (int)
 Set whether the memory is frozen. More...
 
- Public Member Functions inherited from vtkOStreamWrapper
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. More...
 
ostream & GetOStream ()
 Get a reference to the real ostream. More...
 
 operator ostream & ()
 Allow conversion to the real ostream type. More...
 
 operator int ()
 Forward conversion to bool to the real ostream. More...
 
void flush ()
 Forward the flush method to the real ostream. More...
 
 vtkOStreamWrapper (ostream &os)
 Construct class to reference a real ostream. More...
 
 vtkOStreamWrapper (vtkOStreamWrapper &r)
 Construct class to reference a real ostream. More...
 
vtkOStreamWrapperoperator<< (const EndlType &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (const vtkIndent &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (vtkObjectBase &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (const vtkLargeInteger &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (const vtkSmartPointerBase &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (const vtkStdString &)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (const char *)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (void *)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (char)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (short)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (int)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (long)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (long long)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (unsigned char)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (unsigned short)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (unsigned int)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (unsigned long)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (unsigned long long)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (float)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (double)
 Forward this output operator to the real ostream. More...
 
vtkOStreamWrapperoperator<< (bool)
 Forward this output operator to the real ostream. More...
 

Protected Attributes

char * Result
 
int Frozen
 
- Protected Attributes inherited from vtkOStreamWrapper
ostream & ostr
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkOStreamWrapper
static void UseEndl (const EndlType &)
 Implementation detail to allow macros to provide an endl that may or may not be used. More...
 

Detailed Description

Wrapper for ostrstream.

Internal VTK use only.

Provides a wrapper around the C++ ostrstream class 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.

Tests:
vtkOStrStreamWrapper (Tests)

Definition at line 28 of file vtkOStrStreamWrapper.h.

Constructor & Destructor Documentation

◆ vtkOStrStreamWrapper()

vtkOStrStreamWrapper::vtkOStrStreamWrapper ( )

Constructor.

◆ ~vtkOStrStreamWrapper()

vtkOStrStreamWrapper::~vtkOStrStreamWrapper ( )
override

Destructor frees all used memory.

Member Function Documentation

◆ str()

char* vtkOStrStreamWrapper::str ( )

Get the string that has been written.

This call transfers ownership of the returned memory to the caller. Call rdbuf()->freeze(0) to return ownership to the vtkOStrStreamWrapper.

◆ rdbuf()

vtkOStrStreamWrapper* vtkOStrStreamWrapper::rdbuf ( )

Returns a pointer to this class.

This is a hack so that the old ostrstream's s.rdbuf()->freeze(0) can work.

◆ freeze() [1/2]

void vtkOStrStreamWrapper::freeze ( )

Set whether the memory is frozen.

The vtkOStrStreamWrapper will free the memory returned by str() only if it is not frozen.

◆ freeze() [2/2]

void vtkOStrStreamWrapper::freeze ( int  )

Set whether the memory is frozen.

The vtkOStrStreamWrapper will free the memory returned by str() only if it is not frozen.

Member Data Documentation

◆ Result

char* vtkOStrStreamWrapper::Result
protected

Definition at line 65 of file vtkOStrStreamWrapper.h.

◆ Frozen

int vtkOStrStreamWrapper::Frozen
protected

Definition at line 68 of file vtkOStrStreamWrapper.h.


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