LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ast::StringStream Class Reference

String-based source and sink for channels. More...

#include <Stream.h>

Inheritance diagram for ast::StringStream:
ast::Stream

Public Member Functions

 StringStream (std::string const &data="")
 Construct a StringStream. More...
 
virtual ~StringStream ()
 
std::string getSourceData () const
 Get a copy of the text from the sink/output stream, without changing the stream. More...
 
std::string getSinkData () const
 Get a copy of the text from the sink/output stream, without changing the stream. More...
 
void sinkToSource ()
 Move output/sink data to input/source. More...
 
bool hasStdStream ()
 Return true if this Stream has an input or output std::stream. More...
 
char const * source ()
 Source (read) from the stream. More...
 
bool sink (char const *cstr)
 Sink (write) to the stream. More...
 
bool getIsFits () const
 get isfits More...
 

Protected Member Functions

void setIsFits (bool isFits)
 set isFits More...
 

Protected Attributes

std::shared_ptr< std::istream_istreamPtr
 input stream More...
 
std::shared_ptr< std::ostream_ostreamPtr
 output stream More...
 
std::string _sourceStr
 string containing a local copy of sourced data, so source can return a char * that won't disappear right away More...
 
bool _isFits
 is this a FITS stream? More...
 

Detailed Description

String-based source and sink for channels.

This sources from one stringstream and sinks to another. The data can be retrieved at any time, without affecting the stream, using getData.

Definition at line 180 of file Stream.h.

Constructor & Destructor Documentation

◆ StringStream()

ast::StringStream::StringStream ( std::string const &  data = "")
inlineexplicit

Construct a StringStream.

Parameters
[in]datainitial data for the source stream

Definition at line 187 of file Stream.h.

187  : Stream(), _istringstreamPtr(), _ostringstreamPtr() {
188  _istringstreamPtr = std::make_shared<std::istringstream>(data);
189  _ostringstreamPtr = std::make_shared<std::ostringstream>();
190  _istreamPtr = _istringstreamPtr;
191  _ostreamPtr = _ostringstreamPtr;
192  }
char * data
Definition: BaseRecord.cc:61
Stream()
Definition: Stream.h:61
std::shared_ptr< std::ostream > _ostreamPtr
output stream
Definition: Stream.h:132
std::shared_ptr< std::istream > _istreamPtr
input stream
Definition: Stream.h:131

◆ ~StringStream()

virtual ast::StringStream::~StringStream ( )
inlinevirtual

Definition at line 194 of file Stream.h.

194 {}

Member Function Documentation

◆ getIsFits()

bool ast::Stream::getIsFits ( ) const
inlineinherited

get isfits

Definition at line 125 of file Stream.h.

125 { return _isFits; }
bool _isFits
is this a FITS stream?
Definition: Stream.h:136

◆ getSinkData()

std::string ast::StringStream::getSinkData ( ) const
inline

Get a copy of the text from the sink/output stream, without changing the stream.

Definition at line 200 of file Stream.h.

200 { return _ostringstreamPtr->str(); }
T str(T... args)

◆ getSourceData()

std::string ast::StringStream::getSourceData ( ) const
inline

Get a copy of the text from the sink/output stream, without changing the stream.

Definition at line 197 of file Stream.h.

197 { return _istringstreamPtr->str(); }

◆ hasStdStream()

bool ast::Stream::hasStdStream ( )
inlineinherited

Return true if this Stream has an input or output std::stream.

Definition at line 73 of file Stream.h.

73 { return _istreamPtr || _ostreamPtr; }

◆ setIsFits()

void ast::Stream::setIsFits ( bool  isFits)
inlineprotectedinherited

set isFits

Definition at line 129 of file Stream.h.

129 { _isFits = isFits; }

◆ sink()

bool ast::Stream::sink ( char const *  cstr)
inlineinherited

Sink (write) to the stream.

Parameters
[in]cstrdata to write; a newline is then written if _isFits false
Returns
true on success or if there is no stream pointer (a normal mode), false if the stream pointer is in a bad state after writing
Note
this function is not virtual because of type slicing: this function is called from code that casts a void pointer to a Stream pointer without knowing which kind of Stream it is.

Definition at line 110 of file Stream.h.

110  {
111  if (_ostreamPtr) {
112  (*_ostreamPtr) << cstr;
113  if (!_isFits) {
114  (*_ostreamPtr) << std::endl;
115  }
116  return static_cast<bool>(*_ostreamPtr);
117  } else {
118  return true;
119  }
120  }
T endl(T... args)

◆ sinkToSource()

void ast::StringStream::sinkToSource ( )
inline

Move output/sink data to input/source.

Definition at line 203 of file Stream.h.

203  {
204  _istringstreamPtr->clear();
205  _istringstreamPtr->str(getSinkData());
206  _ostringstreamPtr->str("");
207  }
std::string getSinkData() const
Get a copy of the text from the sink/output stream, without changing the stream.
Definition: Stream.h:200
T clear(T... args)

◆ source()

char const* ast::Stream::source ( )
inlineinherited

Source (read) from the stream.

Returns
the data read as a C string, or nullptr if there is no source stream or the source stream is empty or in an error state. The Stream owns the string buffer, and it will be invalidated on the next call to this function.

Definition at line 84 of file Stream.h.

84  {
85  if ((_istreamPtr) && (*_istreamPtr)) {
86  if (_isFits) {
87  // http://codereview.stackexchange.com/a/28759
88  _sourceStr.resize(detail::FITSLEN);
89  _istreamPtr->read(&_sourceStr[0], detail::FITSLEN);
90  } else {
92  }
93  if (*_istreamPtr) {
94  return _sourceStr.c_str();
95  }
96  }
97  return nullptr;
98  }
T c_str(T... args)
std::string _sourceStr
string containing a local copy of sourced data, so source can return a char * that won't disappear ri...
Definition: Stream.h:135
T getline(T... args)
T read(T... args)
T resize(T... args)

Member Data Documentation

◆ _isFits

bool ast::Stream::_isFits
protectedinherited

is this a FITS stream?

Definition at line 136 of file Stream.h.

◆ _istreamPtr

std::shared_ptr<std::istream> ast::Stream::_istreamPtr
protectedinherited

input stream

Definition at line 131 of file Stream.h.

◆ _ostreamPtr

std::shared_ptr<std::ostream> ast::Stream::_ostreamPtr
protectedinherited

output stream

Definition at line 132 of file Stream.h.

◆ _sourceStr

std::string ast::Stream::_sourceStr
protectedinherited

string containing a local copy of sourced data, so source can return a char * that won't disappear right away

Definition at line 135 of file Stream.h.


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