sc_BcastStateSend - Man Page

BcastStateSend does the send part of a broadcast of an object to all nodes.

Synopsis

#include <mstate.h>

Inherits sc::MsgStateSend.

Public Member Functions

BcastStateSend (const Ref< MessageGrp > &)
Create the BcastStateSend.
void flush ()
Flush the data remaining in the buffer.

Public Member Functions inherited from sc::MsgStateSend
MsgStateSend (const Ref< MessageGrp > &)
virtual void flush ()=0
Specializations must implement flush().
void set_buffer_size (int)
The buffer size of statein and stateout objects that communicate with each other must match.
int put (const ClassDesc *)
I only need to override put(const ClassDesc*) but C++ will hide all of the other put's so I must override everything.
int put (char r)
Write the given datum.
int put (unsigned int r)
int put (int r)
int put (float r)
int put (double r)
int put (const char *, int)
Write the given array data.
int put (const int *, int)
int put (const unsigned int *, int)
int put (const float *, int)
int put (const double *, int)

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.
virtual void flush ()
Flush out any remaining data.
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.

Additional Inherited Members

Protected Member Functions inherited from sc::MsgStateSend

int put_array_void (const void *, int)

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 &)

Protected Attributes inherited from sc::MsgStateSend
Ref< MessageGrp > grp
int nbuf
int bufsize
char * buffer
char * send_buffer
int nheader
int * nbuf_buffer

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

BcastStateSend does the send part of a broadcast of an object to all nodes.

Only one node uses a BcastStateSend and the rest must use a BcastStateRecv.

Member Function Documentation

void sc::BcastStateSend::flush () [virtual]

Flush the data remaining in the buffer.

Implements sc::MsgStateSend.

Author

Generated automatically by Doxygen for MPQC from the source code.

Info

Thu Jan 19 2023 Version 2.3.1 MPQC