plucky (3) sc_StateOutFile.3.gz

NAME

       sc::StateOutFile - Writes state information to files.

SYNOPSIS

       #include <state_file.h>

       Inherits sc::StateOut.

       Inherited by sc::StateOutBin, and sc::StateOutText.

   Public Member Functions
       StateOutFile ()
           State information will be written to ExEnv::outn().
       StateOutFile (std::ostream &s)
           State information will be written to s.
       StateOutFile (const char *name)
           State information will be written to name.
       virtual int open (const char *name)
           State information will be written to name.
       virtual void flush ()
           Flush the output stream.
       virtual void close ()
           Close the output stream.

       Public Member Functions inherited from sc::StateOut
       virtual void put_header ()
           Write out header information.
       virtual int putstring (const char *)
           This is like put except the length of the char array is determined by interpreting the
           character array as a character string.
       virtual int put (const std::string &)
           Write out a std::string object.
       virtual int put (char r)
           Write the given datum.
       virtual int put (unsigned int r)
       virtual int put (int r)
       virtual int put (bool r)
       virtual int put (unsigned long r)
       virtual int put (float r)
       virtual int put (double r)
       virtual int put (const char *, int)
           Write the given array data.
       virtual int put (const unsigned int *, int)
       virtual int put (const int *, int)
       virtual int put (const float *, int)
       virtual int put (const double *, int)
       virtual int put_array_char (const char *p, int size)
           Put arrays of data.
       virtual int put_array_uint (const unsigned int *p, int size)
       virtual int put_array_int (const int *p, int size)
       virtual int put_array_float (const float *p, int size)
       virtual int put_array_double (const double *p, int size)
       template<class T > int put (typename std::vector< T > &v)
           Write an STL vector of data.
       void forget_references ()
           Don't keep track of pointers to objects.
       void copy_references ()
           If a reference to an object that has already been written is encountered, copy it
           instead of generating a reference to the first object.
       virtual int use_directory ()
           Returns true if this object uses a directory.
       int node_to_node () const
           True if this is a node to node save/restore.
       virtual int tell ()
           Returns the current position in the file.
       virtual void seek (int loc)
           Set the current position in the file.
       virtual int seekable ()
           Return non-zero if tell and seek do anything sensible.

       Public Member Functions inherited from sc::DescribedClass
       DescribedClass (const DescribedClass &)
       DescribedClass & operator= (const DescribedClass &)
       ClassDesc * class_desc () const  throw ()
           This returns the unique pointer to the ClassDesc corresponding to the given type_info
           object.
       const char * class_name () const
           Return the name of the object's exact type.
       int class_version () const
           Return the version of the class.
       virtual void print (std::ostream &=ExEnv::out0()) const
           Print the object.

       Public Member Functions inherited from sc::RefCount
       int lock_ptr () const
           Lock this object.
       int unlock_ptr () const
           Unlock this object.
       void use_locks (bool inVal)
           start and stop using locks on this object
       refcount_t nreference () const
           Return the reference count.
       refcount_t reference ()
           Increment the reference count and return the new count.
       refcount_t dereference ()
           Decrement the reference count and return the new count.
       int managed () const
       void unmanage ()
           Turn off the reference counting mechanism for this object.
       int managed () const
           Return 1 if the object is managed. Otherwise return 0.

       Public Member Functions inherited from sc::Identity
       Identifier identifier ()
           Return the Identifier for this argument.

   Protected Attributes
       int opened_
       std::streambuf * buf_

       Protected Attributes inherited from sc::StateOut
       int dir_loc_loc_
       TranslateDataOut * translate_
       int copy_references_
       int next_object_number_
       std::map< Ref< SavableState >, StateOutData > ps_
       std::map< ClassDescP, int > classidmap_
       int nextclassid_
       int node_to_node_

   Additional Inherited Members
       Protected Member Functions inherited from sc::StateOut
       virtual int put_array_void (const void *, int)
       virtual int putparents (const ClassDesc *)
       void put_directory ()
       void have_classdesc ()
       int need_classdesc ()
       virtual int putobject (const Ref< SavableState > &)
           This will prepare StateOut to output a pointer to data.
       virtual int put (const ClassDesc *)
           Write out information about the given ClassDesc.

       Protected Member Functions inherited from sc::RefCount
       RefCount (const RefCount &)
       RefCount & operator= (const RefCount &)

Detailed Description

       Writes state information to files.

Member Function Documentation

   virtual void sc::StateOutFile::close () [virtual]
       Close the output stream.

       Reimplemented in sc::StateOutBin.

   virtual void sc::StateOutFile::flush () [virtual]
       Flush the output stream.

       Reimplemented from sc::StateOut.

   virtual int sc::StateOutFile::open (const char * name) [virtual]
       State information will be written to name.

       Reimplemented in sc::StateOutBin.

Author

       Generated automatically by Doxygen for MPQC from the source code.