std::ios man page on Scientific

Man page or keyword search:  
man Server   26626 pages
apropos Keyword Search (all sections)
Output format
Scientific logo
[printable version]

std::basic_ios(3)					     std::basic_ios(3)

NAME
       std::basic_ios -

       Virtual base class for all stream classes.

       Most of the member functions called dispatched on stream objects (e.g.,
       std::cout.foo(bar);) are consolidated in this class.

SYNOPSIS
       Inherits std::ios_base.

       Inherited by std::basic_istream< _CharT, _Traits > [virtual], and
       std::basic_ostream< _CharT, _Traits > [virtual].

   Public Types
       enum event { erase_event, imbue_event, copyfmt_event }
       typedef void(* event_callback )(event, ios_base &, int)
       typedef _Ios_Fmtflags fmtflags
       typedef int io_state
       typedef _Ios_Iostate iostate
       typedef int open_mode
       typedef _Ios_Openmode openmode
       typedef int seek_dir
       typedef _Ios_Seekdir seekdir
       typedef std::streamoff streamoff
       typedef std::streampos streampos

   Public Member Functions
       const locale & _M_getloc () const
       void _M_setstate (iostate __state)
       bool bad () const
       basic_ios (basic_streambuf< _CharT, _Traits > *__sb)
       void clear (iostate __state=goodbit)
       basic_ios & copyfmt (const basic_ios &__rhs)
       bool eof () const
       void exceptions (iostate __except)
       iostate exceptions () const
       bool fail () const
       char_type fill (char_type __ch)
       char_type fill () const
       fmtflags flags (fmtflags __fmtfl)
       fmtflags flags () const
       locale getloc () const
       bool good () const
       locale imbue (const locale &__loc)
       long & iword (int __ix)
       char narrow (char_type __c, char __dfault) const
       streamsize precision (streamsize __prec)
       streamsize precision () const
       void *& pword (int __ix)
       basic_streambuf< _CharT, _Traits > * rdbuf (basic_streambuf< _CharT,
	   _Traits > *__sb)
       basic_streambuf< _CharT, _Traits > * rdbuf () const
       iostate rdstate () const
       void register_callback (event_callback __fn, int __index)
       fmtflags setf (fmtflags __fmtfl, fmtflags __mask)
       fmtflags setf (fmtflags __fmtfl)
       void setstate (iostate __state)
       basic_ostream< _CharT, _Traits > * tie (basic_ostream< _CharT, _Traits
	   > *__tiestr)
       basic_ostream< _CharT, _Traits > * tie () const
       void unsetf (fmtflags __mask)
       char_type widen (char __c) const
       streamsize width (streamsize __wide)
       streamsize width () const
       virtual ~basic_ios ()

   Static Public Member Functions
       static bool sync_with_stdio (bool __sync=true)
       static int xalloc ()  throw ()

   Static Public Attributes
       static const fmtflags adjustfield
       static const openmode app
       static const openmode ate
       static const iostate badbit
       static const fmtflags basefield
       static const seekdir beg
       static const openmode binary
       static const fmtflags boolalpha
       static const seekdir cur
       static const fmtflags dec
       static const seekdir end
       static const iostate eofbit
       static const iostate failbit
       static const fmtflags fixed
       static const fmtflags floatfield
       static const iostate goodbit
       static const fmtflags hex
       static const openmode in
       static const fmtflags internal
       static const fmtflags left
       static const fmtflags oct
       static const openmode out
       static const fmtflags right
       static const fmtflags scientific
       static const fmtflags showbase
       static const fmtflags showpoint
       static const fmtflags showpos
       static const fmtflags skipws
       static const openmode trunc
       static const fmtflags unitbuf
       static const fmtflags uppercase

   Protected Types
       enum { _S_local_word_size }

   Protected Member Functions
       void _M_cache_locale (const locale &__loc)
       void _M_call_callbacks (event __ev)  throw ()
       void _M_dispose_callbacks (void)
       _Words & _M_grow_words (int __index, bool __iword)
       void _M_init ()
       basic_ios ()
       void init (basic_streambuf< _CharT, _Traits > *__sb)

   Protected Attributes
       _Callback_list * _M_callbacks
       const __ctype_type * _M_ctype
       char_type _M_fill
       bool _M_fill_init
       locale _M_ios_locale
       _Words _M_local_word [_S_local_word_size]
       const __num_get_type * _M_num_get
       const __num_put_type * _M_num_put
       basic_streambuf< _CharT, _Traits > * _M_streambuf
       basic_ostream< _CharT, _Traits > * _M_tie
       _Words * _M_word
       int _M_word_size
       _Words _M_word_zero

	   iostate _M_exception
	   fmtflags _M_flags
	   streamsize _M_precision
	   iostate _M_streambuf_state
	   streamsize _M_width
       typedef ctype< _CharT > __ctype_type
       typedef num_get< _CharT, istreambuf_iterator< _CharT, _Traits > >
	   __num_get_type
       typedef num_put< _CharT, ostreambuf_iterator< _CharT, _Traits > >
	   __num_put_type
       typedef _CharT char_type
       typedef _Traits::int_type int_type
       typedef _Traits::off_type off_type
       typedef _Traits::pos_type pos_type
       typedef _Traits traits_type
       operator void * () const
       bool operator! () const

Detailed Description
   template<typename _CharT, typename _Traits> class std::basic_ios< _CharT,
       _Traits >
       Virtual base class for all stream classes.

       Most of the member functions called dispatched on stream objects (e.g.,
       std::cout.foo(bar);) are consolidated in this class.

       Definition at line 62 of file basic_ios.h.

Member Typedef Documentation
   template<typename _CharT, typename _Traits> typedef ctype<_CharT>
       std::basic_ios< _CharT, _Traits >::__ctype_type These are non-standard
       types.
       Reimplemented in std::basic_istream< _CharT, _Traits >,
       std::basic_ostream< _CharT, _Traits >, std::basic_istream< char,
       _Traits >, std::basic_istream< char >, std::basic_ostream< char,
       _Traits >, and std::basic_ostream< char >.

       Definition at line 82 of file basic_ios.h.

   template<typename _CharT, typename _Traits> typedef num_get<_CharT,
       istreambuf_iterator<_CharT, _Traits> > std::basic_ios< _CharT, _Traits
       >::__num_get_type These are non-standard types.
       Reimplemented in std::basic_istream< _CharT, _Traits >,
       std::basic_istream< char, _Traits >, and std::basic_istream< char >.

       Definition at line 86 of file basic_ios.h.

   template<typename _CharT, typename _Traits> typedef num_put<_CharT,
       ostreambuf_iterator<_CharT, _Traits> > std::basic_ios< _CharT, _Traits
       >::__num_put_type
       The quick-and-easy status check. This allows you to write constructs
       such as 'if (!a_stream) ...' and 'while (a_stream) ...'

       Reimplemented in std::basic_ostream< _CharT, _Traits >,
       std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 84 of file basic_ios.h.

   template<typename _CharT, typename _Traits> typedef _CharT std::basic_ios<
       _CharT, _Traits >::char_type These are standard types. They permit a
       standardized way of referring to names of (or names dependant on) the
       template parameters, which are specific to the implementation.
       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istream< _CharT, _Traits >, std::basic_iostream<
       _CharT, _Traits >, std::basic_ostream< _CharT, _Traits >,
       std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >,
       std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_istream<
       char, _Traits >, std::basic_istream< char >, std::basic_iostream< char
       >, std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 71 of file basic_ios.h.

   typedef void(* std::ios_base::event_callback)(event, ios_base &, int)
       [inherited]
       The type of an event callback function. Parameters:
	   event One of the members of the event enum.
	   ios_base Reference to the ios_base object.
	   int The integer provided when the callback was registered.

       Event callbacks are user defined functions that get called during
       several ios_base and basic_ios functions, specifically imbue(),
       copyfmt(), and ~ios().

       Definition at line 444 of file ios_base.h.

   typedef _Ios_Fmtflags std::ios_base::fmtflags [inherited]
       This is a bitmask type. '_Ios_Fmtflags' is implementation-defined, but
       it is valid to perform bitwise operations on these values and expect
       the Right Thing to happen. Defined objects of type fmtflags are:

       · boolalpha

       · dec

       · fixed

       · hex

       · internal

       · left

       · oct

       · right

       · scientific

       · showbase

       · showpoint

       · showpos

       · skipws

       · unitbuf

       · uppercase

       · adjustfield

       · basefield

       · floatfield

       Definition at line 263 of file ios_base.h.

   template<typename _CharT, typename _Traits> typedef _Traits::int_type
       std::basic_ios< _CharT, _Traits >::int_type These are non-standard
       types.
       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istream< _CharT, _Traits >, std::basic_iostream<
       _CharT, _Traits >, std::basic_ostream< _CharT, _Traits >,
       std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >,
       std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_istream<
       char, _Traits >, std::basic_istream< char >, std::basic_iostream< char
       >, std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 72 of file basic_ios.h.

   typedef _Ios_Iostate std::ios_base::iostate [inherited]
       This is a bitmask type. '_Ios_Iostate' is implementation-defined, but
       it is valid to perform bitwise operations on these values and expect
       the Right Thing to happen. Defined objects of type iostate are:

       · badbit

       · eofbit

       · failbit

       · goodbit

       Definition at line 338 of file ios_base.h.

   template<typename _CharT, typename _Traits> typedef _Traits::off_type
       std::basic_ios< _CharT, _Traits >::off_type These are non-standard
       types.
       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istream< _CharT, _Traits >, std::basic_iostream<
       _CharT, _Traits >, std::basic_ostream< _CharT, _Traits >,
       std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >,
       std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_istream<
       char, _Traits >, std::basic_istream< char >, std::basic_iostream< char
       >, std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 74 of file basic_ios.h.

   typedef _Ios_Openmode std::ios_base::openmode [inherited]
       This is a bitmask type. '_Ios_Openmode' is implementation-defined, but
       it is valid to perform bitwise operations on these values and expect
       the Right Thing to happen. Defined objects of type openmode are:

       · app

       · ate

       · binary

       · in

       · out

       · trunc

       Definition at line 369 of file ios_base.h.

   template<typename _CharT, typename _Traits> typedef _Traits::pos_type
       std::basic_ios< _CharT, _Traits >::pos_type These are non-standard
       types.
       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istream< _CharT, _Traits >, std::basic_iostream<
       _CharT, _Traits >, std::basic_ostream< _CharT, _Traits >,
       std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >,
       std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_istream<
       char, _Traits >, std::basic_istream< char >, std::basic_iostream< char
       >, std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 73 of file basic_ios.h.

   typedef _Ios_Seekdir std::ios_base::seekdir [inherited]
       This is an enumerated type. '_Ios_Seekdir' is implementation-defined.
       Defined values of type seekdir are:

       · beg

       · cur, equivalent to SEEK_CUR in the C standard library.

       · end, equivalent to SEEK_END in the C standard library.

       Definition at line 401 of file ios_base.h.

   template<typename _CharT, typename _Traits> typedef _Traits std::basic_ios<
       _CharT, _Traits >::traits_type These are non-standard types.
       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istream< _CharT, _Traits >, std::basic_iostream<
       _CharT, _Traits >, std::basic_ostream< _CharT, _Traits >,
       std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >,
       std::basic_stringstream< _CharT, _Traits, _Alloc >, std::basic_istream<
       char, _Traits >, std::basic_istream< char >, std::basic_iostream< char
       >, std::basic_ostream< char, _Traits >, and std::basic_ostream< char >.

       Definition at line 75 of file basic_ios.h.

Member Enumeration Documentation
   enum std::ios_base::event [inherited]
       The set of events that may be passed to an event callback. erase_event
       is used during ~ios() and copyfmt(). imbue_event is used during
       imbue(). copyfmt_event is used during copyfmt().

       Definition at line 427 of file ios_base.h.

Constructor & Destructor Documentation
   template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits
       >::basic_ios (basic_streambuf< _CharT, _Traits > * __sb) [inline,
       explicit]
       Constructor performs initialization. The parameter is passed by derived
       streams.

       Definition at line 260 of file basic_ios.h.

   template<typename _CharT, typename _Traits> virtual std::basic_ios< _CharT,
       _Traits >::~basic_ios () [inline, virtual]
       Empty. The destructor does nothing. More specifically, it does not
       destroy the streambuf held by rdbuf().

       Definition at line 272 of file basic_ios.h.

   template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits
       >::basic_ios () [inline, protected]
       Empty. The default constructor does nothing and is not normally
       accessible to users.

       Definition at line 450 of file basic_ios.h.

Member Function Documentation
   const locale& std::ios_base::_M_getloc () const [inline, inherited]
       Locale access. Returns:
	   A reference to the current locale.

       Like getloc above, but returns a reference instead of generating a
       copy.

       Definition at line 710 of file ios_base.h.

       Referenced by std::money_get< _CharT, _InIter >::do_get(),
       std::num_get< _CharT, _InIter >::do_get(), std::time_get< _CharT,
       _InIter >::do_get_date(), std::time_get< _CharT, _InIter
       >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_time(),
       std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get<
       _CharT, _InIter >::do_get_year(), std::time_put< _CharT, _OutIter
       >::do_put(), std::num_put< _CharT, _OutIter >::do_put(), and
       std::time_put< _CharT, _OutIter >::put().

   template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT,
       _Traits >::bad () const [inline]
       Fast error checking. Returns:
	   True if the badbit is set.

       Note that other iostate flags may also be set.

       Definition at line 201 of file basic_ios.h.

   template<typename _CharT , typename _Traits > void std::basic_ios< _CharT,
       _Traits >::clear (iostate __state = goodbit) [inline]
       [Re]sets the error state. Parameters:
	   state The new state flag(s) to set.

       See std::ios_base::iostate for the possible bit values. Most users will
       not need to pass an argument.

       Definition at line 40 of file basic_ios.tcc.

       Referenced by std::basic_ios< _CharT, _Traits >::rdbuf().

   template<typename _CharT , typename _Traits > basic_ios< _CharT, _Traits >
       & std::basic_ios< _CharT, _Traits >::copyfmt (const basic_ios< _CharT,
       _Traits > & __rhs) [inline]
       Copies fields of __rhs into this. Parameters:
	   __rhs The source values for the copies.

       Returns:
	   Reference to this object.

       All fields of __rhs are copied into this object except that rdbuf() and
       rdstate() remain unchanged. All values in the pword and iword arrays
       are copied. Before copying, each callback is invoked with erase_event.
       After copying, each (new) callback is invoked with copyfmt_event. The
       final step is to copy exceptions().

       Definition at line 62 of file basic_ios.tcc.

       References std::basic_ios< _CharT, _Traits >::exceptions(),
       std::basic_ios< _CharT, _Traits >::fill(), std::ios_base::flags(),
       std::ios_base::getloc(), std::ios_base::precision(), std::basic_ios<
       _CharT, _Traits >::tie(), and std::ios_base::width().

   template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT,
       _Traits >::eof () const [inline]
       Fast error checking. Returns:
	   True if the eofbit is set.

       Note that other iostate flags may also be set.

       Definition at line 180 of file basic_ios.h.

       Referenced by std::basic_istream< _CharT, _Traits >::get(),
       std::basic_istream< _CharT, _Traits >::getline(), std::basic_istream<
       _CharT, _Traits >::ignore(), std::basic_istream< _CharT, _Traits
       >::peek(), std::basic_istream< _CharT, _Traits >::putback(), and
       std::basic_istream< _CharT, _Traits >::unget().

   template<typename _CharT, typename _Traits> void std::basic_ios< _CharT,
       _Traits >::exceptions (iostate __except) [inline]
       Throwing exceptions on errors. Parameters:
	   except The new exceptions mask.

       By default, error flags are set silently. You can set an exceptions
       mask for each stream; if a bit in the mask becomes set in the error
       flags, then an exception of type std::ios_base::failure is thrown.

       If the error flag is already set when the exceptions mask is added, the
       exception is immediately thrown. Try running the following under GCC
       3.1 or later:

	 #include <iostream>
	 #include <fstream>
	 #include <exception>

	 int main()
	 {
	     std::set_terminate (__gnu_cxx::__verbose_terminate_handler);

	     std::ifstream f ('/etc/motd');

	     std::cerr << 'Setting badbit0;
	     f.setstate (std::ios_base::badbit);

	     std::cerr << 'Setting exception mask0;
	     f.exceptions (std::ios_base::badbit);
	 }

       Definition at line 247 of file basic_ios.h.

   template<typename _CharT, typename _Traits> iostate std::basic_ios< _CharT,
       _Traits >::exceptions () const [inline]
       Throwing exceptions on errors. Returns:
	   The current exceptions mask.

       This changes nothing in the stream. See the one-argument version of
       exceptions(iostate) for the meaning of the return value.

       Definition at line 212 of file basic_ios.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().

   template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT,
       _Traits >::fail () const [inline]
       Fast error checking. Returns:
	   True if either the badbit or the failbit is set.

       Checking the badbit in fail() is historical practice. Note that other
       iostate flags may also be set.

       Definition at line 191 of file basic_ios.h.

       Referenced by std::basic_istream< _CharT, _Traits >::operator>>(),
       std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream<
       _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits
       >::tellg(), and std::basic_ostream< _CharT, _Traits >::tellp().

   template<typename _CharT, typename _Traits> char_type std::basic_ios<
       _CharT, _Traits >::fill (char_type __ch) [inline]
       Sets a new 'empty' character. Parameters:
	   ch The new character.

       Returns:
	   The previous fill character.

       The fill character is used to fill out space when P+ characters have
       been requested (e.g., via setw), Q characters are actually used, and
       Q<P. It defaults to a space (' ') in the current locale.

       Definition at line 380 of file basic_ios.h.

   template<typename _CharT, typename _Traits> char_type std::basic_ios<
       _CharT, _Traits >::fill () const [inline]
       Retrieves the 'empty' character. Returns:
	   The current fill character.

       It defaults to a space (' ') in the current locale.

       Definition at line 360 of file basic_ios.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().

   fmtflags std::ios_base::flags (fmtflags __fmtfl) [inline, inherited]
       Setting new format flags all at once. Parameters:
	   fmtfl The new flags to set.

       Returns:
	   The previous format control flags.

       This function overwrites all the format flags with fmtfl.

       Definition at line 566 of file ios_base.h.

   fmtflags std::ios_base::flags () const [inline, inherited]
       Access to format flags. Returns:
	   The format control flags for both input and output.

       Definition at line 555 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
       std::num_get< _CharT, _InIter >::do_get(), std::num_put< _CharT,
       _OutIter >::do_put(), std::basic_ostream< _CharT, _Traits
       >::operator<<(), and std::operator<<().

   locale std::ios_base::getloc () const [inline, inherited]
       Locale access. Returns:
	   A copy of the current locale.

       If imbue(loc) has previously been called, then this function returns
       loc. Otherwise, it returns a copy of std::locale(), the global C++
       locale.

       Definition at line 699 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
       std::money_put< _CharT, _OutIter >::do_put(), std::basic_ios< _CharT,
       _Traits >::imbue(), std::operator>>(), and std::ws().

   template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT,
       _Traits >::good () const [inline]
       Fast error checking. Returns:
	   True if no error flags are set.

       A wrapper around rdstate.

       Definition at line 170 of file basic_ios.h.

   template<typename _CharT , typename _Traits > locale std::basic_ios<
       _CharT, _Traits >::imbue (const locale & __loc) [inline]
       Moves to a new locale. Parameters:
	   loc The new locale.

       Returns:
	   The previous locale.

       Calls ios_base::imbue(loc), and if a stream buffer is associated with
       this stream, calls that buffer's pubimbue(loc).

       Additional l10n notes are at
       http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

       Reimplemented from std::ios_base.

       Definition at line 113 of file basic_ios.tcc.

       References std::ios_base::getloc(), and std::basic_ios< _CharT, _Traits
       >::rdbuf().

       Referenced by std::operator<<().

   template<typename _CharT, typename _Traits> void std::basic_ios< _CharT,
       _Traits >::init (basic_streambuf< _CharT, _Traits > * __sb) [inline,
       protected]
       All setup is performed here. This is called from the public
       constructor. It is not virtual and cannot be redefined.

       Definition at line 125 of file basic_ios.tcc.

       References std::ios_base::_M_exception,
       std::ios_base::_M_streambuf_state, std::ios_base::badbit, and
       std::ios_base::goodbit.

   long& std::ios_base::iword (int __ix) [inline, inherited]
       Access to integer array. Parameters:
	   __ix Index into the array.

       Returns:
	   A reference to an integer associated with the index.

       The iword function provides access to an array of integers that can be
       used for any purpose. The array grows as required to hold the supplied
       index. All integers in the array are initialized to 0.

       The implementation reserves several indices. You should use xalloc to
       obtain an index that is safe to use. Also note that since the array can
       grow dynamically, it is not safe to hold onto the reference.

       Definition at line 745 of file ios_base.h.

   template<typename _CharT, typename _Traits> char std::basic_ios< _CharT,
       _Traits >::narrow (char_type __c, char __dfault) const [inline]
       Squeezes characters. Parameters:
	   c The character to narrow.
	   dfault The character to narrow.

       Returns:
	   The narrowed character.

       Maps a character of char_type to a character of char, if possible.

       Returns the result of

	   std::use_facet<ctype<char_type> >(getloc()).narrow(c,dfault)

       Additional l10n notes are at
       http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

       Definition at line 420 of file basic_ios.h.

   template<typename _CharT, typename _Traits> std::basic_ios< _CharT, _Traits
       >::operator void * () const [inline]
       The quick-and-easy status check. This allows you to write constructs
       such as 'if (!a_stream) ...' and 'while (a_stream) ...'

       Definition at line 111 of file basic_ios.h.

   template<typename _CharT, typename _Traits> bool std::basic_ios< _CharT,
       _Traits >::operator! () const [inline]
       The quick-and-easy status check. This allows you to write constructs
       such as 'if (!a_stream) ...' and 'while (a_stream) ...'

       Definition at line 115 of file basic_ios.h.

   streamsize std::ios_base::precision (streamsize __prec) [inline, inherited]
       Changing flags. Parameters:
	   prec The new precision value.

       Returns:
	   The previous value of precision().

       Definition at line 634 of file ios_base.h.

   streamsize std::ios_base::precision () const [inline, inherited]
       Flags access. Returns:
	   The precision to generate on certain output operations.

       Be careful if you try to give a definition of 'precision' here; see DR
       189.

       Definition at line 625 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(), and
       std::operator<<().

   void*& std::ios_base::pword (int __ix) [inline, inherited]
       Access to void pointer array. Parameters:
	   __ix Index into the array.

       Returns:
	   A reference to a void* associated with the index.

       The pword function provides access to an array of pointers that can be
       used for any purpose. The array grows as required to hold the supplied
       index. All pointers in the array are initialized to 0.

       The implementation reserves several indices. You should use xalloc to
       obtain an index that is safe to use. Also note that since the array can
       grow dynamically, it is not safe to hold onto the reference.

       Definition at line 766 of file ios_base.h.

   template<typename _CharT, typename _Traits> basic_streambuf< _CharT,
       _Traits > * std::basic_ios< _CharT, _Traits >::rdbuf (basic_streambuf<
       _CharT, _Traits > * __sb) [inline]
       Changing the underlying buffer. Parameters:
	   sb The new stream buffer.

       Returns:
	   The previous stream buffer.

       Associates a new buffer with the current stream, and clears the error
       state.

       Due to historical accidents which the LWG refuses to correct, the I/O
       library suffers from a design error: this function is hidden in derived
       classes by overrides of the zero-argument rdbuf(), which is non-virtual
       for hysterical raisins. As a result, you must use explicit
       qualifications to access this function via any derived class. For
       example:

	 std::fstream	  foo;	       // or some other derived type
	 std::streambuf*  p = .....;

	 foo.ios::rdbuf(p);	       // ios == basic_ios<char>

       Definition at line 52 of file basic_ios.tcc.

       References std::basic_ios< _CharT, _Traits >::clear().

   template<typename _CharT, typename _Traits> basic_streambuf<_CharT,
       _Traits>* std::basic_ios< _CharT, _Traits >::rdbuf () const [inline]
       Accessing the underlying buffer. Returns:
	   The current stream buffer.

       This does not change the state of the stream.

       Reimplemented in std::basic_ifstream< _CharT, _Traits >,
       std::basic_ofstream< _CharT, _Traits >, std::basic_fstream< _CharT,
       _Traits >, std::basic_istringstream< _CharT, _Traits, _Alloc >,
       std::basic_ostringstream< _CharT, _Traits, _Alloc >, and
       std::basic_stringstream< _CharT, _Traits, _Alloc >.

       Definition at line 311 of file basic_ios.h.

       Referenced by std::basic_ostream< _CharT, _Traits >::flush(),
       std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
       _CharT, _Traits >::getline(), std::getline(), std::basic_istream<
       _CharT, _Traits >::ignore(), std::basic_ios< _CharT, _Traits
       >::imbue(), std::basic_ostream< _CharT, _Traits >::operator<<(),
       std::basic_istream< _CharT, _Traits >::operator>>(), std::operator>>(),
       std::basic_istream< _CharT, _Traits >::peek(), std::basic_ostream<
       _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits
       >::putback(), std::basic_istream< _CharT, _Traits >::read(),
       std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream<
       _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits
       >::seekp(), std::basic_istream< _CharT, _Traits >::sync(),
       std::basic_istream< _CharT, _Traits >::tellg(), std::basic_ostream<
       _CharT, _Traits >::tellp(), std::basic_istream< _CharT, _Traits
       >::unget(), and std::ws().

   template<typename _CharT, typename _Traits> iostate std::basic_ios< _CharT,
       _Traits >::rdstate () const [inline]
       Returns the error state of the stream buffer. Returns:
	   A bit pattern (well, isn't everything?)

       See std::ios_base::iostate for the possible bit values. Most users will
       call one of the interpreting wrappers, e.g., good().

       Definition at line 127 of file basic_ios.h.

   void std::ios_base::register_callback (event_callback __fn, int __index)
       [inherited]
       Add the callback __fn with parameter __index. Parameters:
	   __fn The function to add.
	   __index The integer to pass to the function when invoked.

       Registers a function as an event callback with an integer parameter to
       be passed to the function when invoked. Multiple copies of the function
       are allowed. If there are multiple callbacks, they are invoked in the
       order they were registered.

   fmtflags std::ios_base::setf (fmtflags __fmtfl, fmtflags __mask) [inline,
       inherited]
       Setting new format flags. Parameters:
	   fmtfl Additional flags to set.
	   mask The flags mask for fmtfl.

       Returns:
	   The previous format control flags.

       This function clears mask in the format flags, then sets fmtfl & mask.
       An example mask is ios_base::adjustfield.

       Definition at line 599 of file ios_base.h.

   fmtflags std::ios_base::setf (fmtflags __fmtfl) [inline, inherited]
       Setting new format flags. Parameters:
	   fmtfl Additional flags to set.

       Returns:
	   The previous format control flags.

       This function sets additional flags in format control. Flags that were
       previously set remain set.

       Definition at line 582 of file ios_base.h.

       Referenced by std::boolalpha(), std::dec(), std::fixed(), std::hex(),
       std::internal(), std::left(), std::oct(), std::right(),
       std::scientific(), std::showbase(), std::showpoint(), std::showpos(),
       std::skipws(), std::unitbuf(), and std::uppercase().

   template<typename _CharT, typename _Traits> void std::basic_ios< _CharT,
       _Traits >::setstate (iostate __state) [inline]
       Sets additional flags in the error state. Parameters:
	   state The additional state flag(s) to set.

       See std::ios_base::iostate for the possible bit values.

       Definition at line 147 of file basic_ios.h.

       Referenced by std::basic_ostream< _CharT, _Traits >::flush(),
       std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
       _CharT, _Traits >::getline(), std::getline(), std::basic_istream<
       _CharT, _Traits >::ignore(), std::basic_ostream< _CharT, _Traits
       >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(),
       std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(),
       std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream<
       _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits
       >::read(), std::basic_istream< _CharT, _Traits >::readsome(),
       std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream<
       _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits
       >::sync(), std::basic_istream< _CharT, _Traits >::unget(), and
       std::ws().

   static bool std::ios_base::sync_with_stdio (bool __sync = true) [static,
       inherited]
       Interaction with the standard C I/O objects. Parameters:
	   sync Whether to synchronize or not.

       Returns:
	   True if the standard streams were previously synchronized.

       The synchronization referred to is only that between the standard C
       facilities (e.g., stdout) and the standard C++ objects (e.g., cout).
       User-declared streams are unaffected. See
       http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch28s02.html

   template<typename _CharT, typename _Traits> basic_ostream<_CharT, _Traits>*
       std::basic_ios< _CharT, _Traits >::tie (basic_ostream< _CharT, _Traits
       > * __tiestr) [inline]
       Ties this stream to an output stream. Parameters:
	   tiestr The output stream.

       Returns:
	   The previously tied output stream, or NULL if the stream was not
	   tied.

       This sets up a new tie; see tie() for more.

       Definition at line 297 of file basic_ios.h.

   template<typename _CharT, typename _Traits> basic_ostream<_CharT, _Traits>*
       std::basic_ios< _CharT, _Traits >::tie () const [inline]
       Fetches the current tied stream. Returns:
	   A pointer to the tied stream, or NULL if the stream is not tied.

       A stream may be tied (or synchronized) to a second output stream. When
       this stream performs any I/O, the tied stream is first flushed. For
       example, std::cin is tied to std::cout.

       Definition at line 285 of file basic_ios.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt().

   void std::ios_base::unsetf (fmtflags __mask) [inline, inherited]
       Clearing format flags. Parameters:
	   mask The flags to unset.

       This function clears mask in the format flags.

       Definition at line 614 of file ios_base.h.

       Referenced by std::noboolalpha(), std::noshowbase(),
       std::noshowpoint(), std::noshowpos(), std::noskipws(),
       std::nounitbuf(), and std::nouppercase().

   template<typename _CharT, typename _Traits> char_type std::basic_ios<
       _CharT, _Traits >::widen (char __c) const [inline]
       Widens characters. Parameters:
	   c The character to widen.

       Returns:
	   The widened character.

       Maps a character of char to a character of char_type.

       Returns the result of

	   std::use_facet<ctype<char_type> >(getloc()).widen(c)

       Additional l10n notes are at
       http://gcc.gnu.org/onlinedocs/libstdc++/manual/localization.html

       Definition at line 439 of file basic_ios.h.

       Referenced by std::endl(), std::getline(), and std::operator>>().

   streamsize std::ios_base::width (streamsize __wide) [inline, inherited]
       Changing flags. Parameters:
	   wide The new width value.

       Returns:
	   The previous value of width().

       Definition at line 657 of file ios_base.h.

   streamsize std::ios_base::width () const [inline, inherited]
       Flags access. Returns:
	   The minimum field width to generate on output operations.

       Definition at line 648 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::copyfmt(),
       std::num_put< _CharT, _OutIter >::do_put(), and std::operator>>().

   static int std::ios_base::xalloc ()	throw () [static, inherited]
       Access to unique indices. Returns:
	   An integer different from all previous calls.

       This function returns a unique integer every time it is called. It can
       be used for any purpose, but is primarily intended to be a unique index
       for the iword and pword functions. The expectation is that an
       application calls xalloc in order to obtain an index in the iword and
       pword arrays that can be used without fear of conflict.

       The implementation maintains a static variable that is incremented and
       returned on each invocation. xalloc is guaranteed to return an index
       that is safe to use in the iword and pword arrays.

Member Data Documentation
   iostate std::ios_base::_M_exception [protected, inherited] ios_base data
       members (doc me)
       Definition at line 467 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::init().

   fmtflags std::ios_base::_M_flags [protected, inherited] ios_base data
       members (doc me)
       Definition at line 466 of file ios_base.h.

   streamsize std::ios_base::_M_precision [protected, inherited] ios_base data
       members (doc me)
       Definition at line 464 of file ios_base.h.

   iostate std::ios_base::_M_streambuf_state [protected, inherited] ios_base
       data members (doc me)
       Definition at line 468 of file ios_base.h.

       Referenced by std::basic_ios< _CharT, _Traits >::init().

   streamsize std::ios_base::_M_width [protected, inherited] ios_base data
       members (doc me)
       Definition at line 465 of file ios_base.h.

   const fmtflags std::ios_base::adjustfield [static, inherited]
       A mask of left|right|internal. Useful for the 2-arg form of setf.

       Definition at line 318 of file ios_base.h.

       Referenced by std::num_put< _CharT, _OutIter >::do_put().

   const openmode std::ios_base::app [static, inherited]
       Seek to end before each write.

       Definition at line 372 of file ios_base.h.

   const openmode std::ios_base::ate [static, inherited]
       Open and seek to end immediately after opening.

       Definition at line 375 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::open().

   const iostate std::ios_base::badbit [static, inherited]
       Indicates a loss of integrity in an input or output sequence (such as
       an irrecoverable read error from a file).

       Definition at line 342 of file ios_base.h.

       Referenced by std::basic_ostream< _CharT, _Traits >::flush(),
       std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
       _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits
       >::ignore(), std::basic_ios< _CharT, _Traits >::init(),
       std::operator<<(), std::basic_ostream< _CharT, _Traits >::operator<<(),
       std::operator>>(), std::basic_istream< _CharT, _Traits >::peek(),
       std::basic_ostream< _CharT, _Traits >::put(), std::basic_istream<
       _CharT, _Traits >::putback(), std::basic_istream< _CharT, _Traits
       >::read(), std::basic_istream< _CharT, _Traits >::readsome(),
       std::basic_istream< _CharT, _Traits >::seekg(), std::basic_ostream<
       _CharT, _Traits >::seekp(), std::basic_istream< _CharT, _Traits
       >::sync(), std::basic_istream< _CharT, _Traits >::tellg(),
       std::basic_ostream< _CharT, _Traits >::tellp(), std::basic_istream<
       _CharT, _Traits >::unget(), and std::basic_ostream< _CharT, _Traits
       >::write().

   const fmtflags std::ios_base::basefield [static, inherited]
       A mask of dec|oct|hex. Useful for the 2-arg form of setf.

       Definition at line 321 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), and
       std::basic_ostream< _CharT, _Traits >::operator<<().

   const seekdir std::ios_base::beg [static, inherited]
       Request a seek relative to the beginning of the stream.

       Definition at line 404 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::seekpos().

   const openmode std::ios_base::binary [static, inherited]
       Perform input and output in binary mode (as opposed to text mode). This
       is probably not what you think it is; see
       http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch27s02.html.

       Definition at line 380 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::showmanyc().

   const fmtflags std::ios_base::boolalpha [static, inherited]
       Insert/extract bool in alphabetic rather than numeric format.

       Definition at line 266 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), and
       std::num_put< _CharT, _OutIter >::do_put().

   const seekdir std::ios_base::cur [static, inherited]
       Request a seek relative to the current position within the sequence.

       Definition at line 407 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::imbue(),
       std::basic_filebuf< _CharT, _Traits >::pbackfail(),
       std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(),
       std::basic_filebuf< _CharT, _Traits >::seekoff(), std::basic_istream<
       _CharT, _Traits >::tellg(), and std::basic_ostream< _CharT, _Traits
       >::tellp().

   const fmtflags std::ios_base::dec [static, inherited]
       Converts integer input or generates integer output in decimal base.

       Definition at line 269 of file ios_base.h.

   const seekdir std::ios_base::end [static, inherited]
       Request a seek relative to the current end of the sequence.

       Definition at line 410 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::open(), and
       std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff().

   const iostate std::ios_base::eofbit [static, inherited]
       Indicates that an input operation reached the end of an input sequence.

       Definition at line 345 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), std::time_get<
       _CharT, _InIter >::do_get_date(), std::time_get< _CharT, _InIter
       >::do_get_monthname(), std::time_get< _CharT, _InIter >::do_get_time(),
       std::time_get< _CharT, _InIter >::do_get_weekday(), std::time_get<
       _CharT, _InIter >::do_get_year(), std::basic_istream< _CharT, _Traits
       >::get(), std::basic_istream< _CharT, _Traits >::getline(),
       std::basic_istream< _CharT, _Traits >::ignore(), std::operator>>(),
       std::basic_istream< _CharT, _Traits >::operator>>(),
       std::basic_istream< _CharT, _Traits >::peek(), std::basic_istream<
       _CharT, _Traits >::read(), std::basic_istream< _CharT, _Traits
       >::readsome(), and std::ws().

   const iostate std::ios_base::failbit [static, inherited]
       Indicates that an input operation failed to read the expected
       characters, or that an output operation failed to generate the desired
       characters.

       Definition at line 350 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), std::time_get<
       _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter
       >::do_get_weekday(), std::time_get< _CharT, _InIter >::do_get_year(),
       std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
       _CharT, _Traits >::getline(), std::basic_ostream< _CharT, _Traits
       >::operator<<(), std::basic_istream< _CharT, _Traits >::operator>>(),
       std::operator>>(), std::basic_istream< _CharT, _Traits >::read(),
       std::basic_istream< _CharT, _Traits >::seekg(), and std::basic_ostream<
       _CharT, _Traits >::seekp().

   const fmtflags std::ios_base::fixed [static, inherited]
       Generate floating-point output in fixed-point notation.

       Definition at line 272 of file ios_base.h.

   const fmtflags std::ios_base::floatfield [static, inherited]
       A mask of scientific|fixed. Useful for the 2-arg form of setf.

       Definition at line 324 of file ios_base.h.

   const iostate std::ios_base::goodbit [static, inherited]
       Indicates all is well.

       Definition at line 353 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), std::time_get<
       _CharT, _InIter >::do_get_monthname(), std::time_get< _CharT, _InIter
       >::do_get_weekday(), std::basic_ostream< _CharT, _Traits >::flush(),
       std::basic_istream< _CharT, _Traits >::get(), std::basic_istream<
       _CharT, _Traits >::getline(), std::basic_istream< _CharT, _Traits
       >::ignore(), std::basic_ios< _CharT, _Traits >::init(),
       std::basic_ostream< _CharT, _Traits >::operator<<(), std::operator>>(),
       std::basic_istream< _CharT, _Traits >::operator>>(),
       std::basic_istream< _CharT, _Traits >::peek(), std::basic_ostream<
       _CharT, _Traits >::put(), std::basic_istream< _CharT, _Traits
       >::putback(), std::basic_istream< _CharT, _Traits >::read(),
       std::basic_istream< _CharT, _Traits >::readsome(), std::basic_istream<
       _CharT, _Traits >::seekg(), std::basic_ostream< _CharT, _Traits
       >::seekp(), std::basic_istream< _CharT, _Traits >::sync(), and
       std::basic_istream< _CharT, _Traits >::unget().

   const fmtflags std::ios_base::hex [static, inherited]
       Converts integer input or generates integer output in hexadecimal base.

       Definition at line 275 of file ios_base.h.

       Referenced by std::num_get< _CharT, _InIter >::do_get(), std::num_put<
       _CharT, _OutIter >::do_put(), and std::basic_ostream< _CharT, _Traits
       >::operator<<().

   const openmode std::ios_base::in [static, inherited]
       Open for input. Default for ifstream and fstream.

       Definition at line 383 of file ios_base.h.

       Referenced by std::basic_filebuf< _CharT, _Traits >::pbackfail(),
       std::basic_istream< _CharT, _Traits >::seekg(), std::basic_stringbuf<
       _CharT, _Traits, _Alloc >::seekoff(), std::basic_stringbuf< _CharT,
       _Traits, _Alloc >::seekpos(), std::basic_filebuf< _CharT, _Traits
       >::showmanyc(), std::basic_istream< _CharT, _Traits >::tellg(),
       std::basic_stringbuf< _CharT, _Traits, _Alloc >::underflow(),
       std::basic_filebuf< _CharT, _Traits >::underflow(), and
       std::basic_filebuf< _CharT, _Traits >::xsgetn().

   const fmtflags std::ios_base::internal [static, inherited]
       Adds fill characters at a designated internal point in certain
       generated output, or identical to right if no such point is designated.

       Definition at line 280 of file ios_base.h.

   const fmtflags std::ios_base::left [static, inherited]
       Adds fill characters on the right (final positions) of certain
       generated output. (I.e., the thing you print is flush left.).

       Definition at line 284 of file ios_base.h.

       Referenced by std::num_put< _CharT, _OutIter >::do_put().

   const fmtflags std::ios_base::oct [static, inherited]
       Converts integer input or generates integer output in octal base.

       Definition at line 287 of file ios_base.h.

       Referenced by std::basic_ostream< _CharT, _Traits >::operator<<().

   const openmode std::ios_base::out [static, inherited]
       Open for output. Default for ofstream and fstream.

       Definition at line 386 of file ios_base.h.

       Referenced by std::basic_stringbuf< _CharT, _Traits, _Alloc
       >::overflow(), std::basic_filebuf< _CharT, _Traits >::overflow(),
       std::basic_stringbuf< _CharT, _Traits, _Alloc >::seekoff(),
       std::basic_ostream< _CharT, _Traits >::seekp(), std::basic_stringbuf<
       _CharT, _Traits, _Alloc >::seekpos(), std::basic_ostream< _CharT,
       _Traits >::tellp(), and std::basic_filebuf< _CharT, _Traits
       >::xsputn().

   const fmtflags std::ios_base::right [static, inherited]
       Adds fill characters on the left (initial positions) of certain
       generated output. (I.e., the thing you print is flush right.).

       Definition at line 291 of file ios_base.h.

   const fmtflags std::ios_base::scientific [static, inherited]
       Generates floating-point output in scientific notation.

       Definition at line 294 of file ios_base.h.

   const fmtflags std::ios_base::showbase [static, inherited]
       Generates a prefix indicating the numeric base of generated integer
       output.

       Definition at line 298 of file ios_base.h.

   const fmtflags std::ios_base::showpoint [static, inherited]
       Generates a decimal-point character unconditionally in generated
       floating-point output.

       Definition at line 302 of file ios_base.h.

   const fmtflags std::ios_base::showpos [static, inherited]
       Generates a + sign in non-negative generated numeric output.

       Definition at line 305 of file ios_base.h.

   const fmtflags std::ios_base::skipws [static, inherited]
       Skips leading white space before certain input operations.

       Definition at line 308 of file ios_base.h.

   const openmode std::ios_base::trunc [static, inherited]
       Open for input. Default for ofstream.

       Definition at line 389 of file ios_base.h.

   const fmtflags std::ios_base::unitbuf [static, inherited]
       Flushes output after each output operation.

       Definition at line 311 of file ios_base.h.

   const fmtflags std::ios_base::uppercase [static, inherited]
       Replaces certain lowercase letters with their uppercase equivalents in
       generated output.

       Definition at line 315 of file ios_base.h.

       Referenced by std::num_put< _CharT, _OutIter >::do_put().

Author
       Generated automatically by Doxygen for libstdc++ from the source code.

libstdc++			  22 Nov 2013		     std::basic_ios(3)
[top]

List of man pages available for Scientific

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net