sc::StateOutText Class Reference

#include <util/state/state_text.h>

Inheritance diagram for sc::StateOutText:

Public Member Functions
	StateOutText (std::ostream &s)
	StateOutText (const char *)
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.
int	put_array_char (const char *, int)
int	put_array_uint (const unsigned int *, int)
int	put_array_int (const int *, int)
int	put_array_ulong (const unsigned long *, int)
int	put_array_long (const long *, int)
int	put_array_float (const float *, int)
int	put_array_double (const double *, int)
int	put (const ClassDesc *)
	Write out information about the given ClassDesc.
int	put (const std::string &)
int	put (char r)
int	put (unsigned int r)
int	put (int r)
int	put (unsigned long r)
int	put (long r)
int	put (bool r)
int	put (float r)
int	put (double r)
int	put (const char *, int)
int	put (const unsigned int *, int)
int	put (const int *, int)
int	put (const unsigned long *, int)
int	put (const long *, int)
int	put (const float *, int)
int	put (const double *, int)
Public Member Functions inherited from sc::StateOutFile
	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.
template<template< typename, typename > class Container, class T , class A >
int	put (const Container< T, A > &v)
	Write a Container that could be a standard (non-associative) C++ container such as std::vector or std::list.
template<class T , class A >
int	put (const std::vector< T, A > &v)
	"Specialization" of the above put() to std::vector.
template<typename Key , typename Compare , typename Alloc >
int	put (const std::set< Key, Compare, Alloc > &s)
	Write an std::set. This also works if Key or Value is a Ref to a SavableState.
template<typename Key , typename Value >
int	put (const std::map< Key, Value > &map)
	Write an std::map. This also works if Key or Value is a Ref to a SavableState.
template<typename L , typename R >
int	put (const std::pair< L, R > &v)
	Write an std::pair.
void	forget_references ()
	Don't keep track of pointers to objects. More...
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. More...
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. More...
virtual int	tell ()
	Returns the current position in the file. More...
virtual void	seek (int loc)
	Set the current position in the file. More...
virtual int	seekable ()
	Return non-zero if tell and seek do anything sensible. More...
Public Member Functions inherited from sc::DescribedClass
	DescribedClass (const DescribedClass &)
DescribedClass &	operator= (const DescribedClass &)
ClassDesc *	class_desc () const MPQC__NOEXCEPT
	This returns the unique pointer to the ClassDesc corresponding to the given type_info object. More...
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.
Ref< DescribedClass >	ref ()
	Return this object wrapped up in a Ref smart pointer. More...
Public Member Functions inherited from sc::RefCount
size_t	identifier () const
	Return the unique identifier for this object that can be compared for different objects of different types. More...
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. More...

Protected Member Functions
void	no_newline ()
void	no_array ()
void	newline ()
void	start_array ()
void	end_array ()
int	putobject (const Ref< SavableState > &)
	This will prepare StateOut to output a pointer to data. More...
int	putparents (const ClassDesc *)
Protected Member Functions inherited from sc::StateOut
virtual int	put_array_void (const void *, int)
void	put_directory ()
void	have_classdesc ()
int	need_classdesc ()
Protected Member Functions inherited from sc::RefCount
	RefCount (const RefCount &)
RefCount &	operator= (const RefCount &)

Protected Attributes
int	no_newline_
int	no_array_
Protected Attributes inherited from sc::StateOutFile
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_

Detailed Description

Writes out state information in an almost human readable format.

StateOutText is intended for debugging only. The state information can read in again with StateInText.

Member Function Documentation

putobject()

int sc::StateOutText::putobject ( const Ref< SavableState > &  )

protectedvirtual

This will prepare StateOut to output a pointer to data.

It first checks to see if the data has already been saved. If it has, then a reference to this data is saved. Otherwise the object is written out.

Reimplemented from sc::StateOut.

---

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

• src/lib/util/state/state_text.h