IBTK::StreamableFactory Class Reference

Class StreamableFactory is an abstract interface for classes that can unpack particular concrete Streamable objects from SAMRAI::tbox::AbstractStream data streams. More...

#include <ibtk/StreamableFactory.h>

Inheritance diagram for IBTK::StreamableFactory:

Public Member Functions
	StreamableFactory ()=default
	Default empty constructor. More...
virtual	~StreamableFactory ()=default
	Virtual destructor. More...
virtual int	getStreamableClassID () const =0
	Return the unique class identifier used to specify the StreamableFactory object used by the StreamableManager to extract Streamable objects from data streams. More...
virtual void	setStreamableClassID (int class_id)=0
	Set the unique identifier used to specify the StreamableFactory object used by the StreamableManager to extract Streamable objects from data streams. More...
virtual SAMRAI::tbox::Pointer< Streamable >	unpackStream (SAMRAI::tbox::AbstractStream &stream, const SAMRAI::hier::IntVector< NDIM > &offset)=0
	Build a Streamable object by unpacking data from the data stream. More...

Private Member Functions
	StreamableFactory (const StreamableFactory &from)=delete
	Copy constructor. More...
StreamableFactory &	operator= (const StreamableFactory &that)=delete
	Assignment operator. More...

Detailed Description

Note

Each concrete Streamable class must have a corresponding concrete StreamableFactory class. Classes that implement the Streamable interface are able to pack themselves into a stream; the corresponding StreamableFactory class is used to unpack that data and construct the corresponding Streamable object.

Class StreamableManager should be used for all communications and storage operations.

See also

Streamable

StreamableManager

Constructor & Destructor Documentation

StreamableFactory() [1/2]

IBTK::StreamableFactory::StreamableFactory ( )

default

~StreamableFactory()

virtual IBTK::StreamableFactory::~StreamableFactory ( )

virtualdefault

StreamableFactory() [2/2]

IBTK::StreamableFactory::StreamableFactory ( const StreamableFactory &  from )

privatedelete

Note

This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

getStreamableClassID()

virtual int IBTK::StreamableFactory::getStreamableClassID ( ) const

pure virtual

Implemented in IBAMR::IBSpringForceSpec::Factory, IBAMR::IBBeamForceSpec::Factory, IBAMR::MaterialPointSpec::Factory, IBAMR::IBRodForceSpec::Factory, IBAMR::IBInstrumentationSpec::Factory, IBAMR::IBTargetPointForceSpec::Factory, IBAMR::IBSourceSpec::Factory, and IBAMR::IBAnchorPointSpec::Factory.

setStreamableClassID()

virtual void IBTK::StreamableFactory::setStreamableClassID ( int  class_id )

pure virtual

Implemented in IBAMR::IBSpringForceSpec::Factory, IBAMR::IBBeamForceSpec::Factory, IBAMR::MaterialPointSpec::Factory, IBAMR::IBRodForceSpec::Factory, IBAMR::IBInstrumentationSpec::Factory, IBAMR::IBTargetPointForceSpec::Factory, IBAMR::IBSourceSpec::Factory, and IBAMR::IBAnchorPointSpec::Factory.

unpackStream()

virtual SAMRAI::tbox::Pointer<Streamable> IBTK::StreamableFactory::unpackStream ( SAMRAI::tbox::AbstractStream &  stream, const SAMRAI::hier::IntVector< NDIM > &  offset  )

pure virtual

Implemented in IBAMR::IBSpringForceSpec::Factory, IBAMR::IBBeamForceSpec::Factory, IBAMR::MaterialPointSpec::Factory, IBAMR::IBRodForceSpec::Factory, IBAMR::IBInstrumentationSpec::Factory, IBAMR::IBTargetPointForceSpec::Factory, IBAMR::IBSourceSpec::Factory, and IBAMR::IBAnchorPointSpec::Factory.

operator=()

StreamableFactory& IBTK::StreamableFactory::operator= ( const StreamableFactory &  that )

privatedelete

Note

This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

---

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

• ibtk/include/ibtk/StreamableFactory.h