ast::FileStream Class Reference

File-based source or sink (not both) for channels. More...

#include <Stream.h>

Inheritance diagram for ast::FileStream:

Public Member Functions
	FileStream (std::string const &path, bool doWrite=false)
	Construct a FileStream for reading or writing, but not both.
virtual	~FileStream ()
std::string	getPath () const
	Get the path to the file, as a string.
bool	hasStdStream ()
	Return true if this Stream has an input or output std::stream.
char const *	source ()
	Source (read) from the stream.
bool	sink (char const *cstr)
	Sink (write) to the stream.
bool	getIsFits () const
	get isfits

Protected Member Functions
void	setIsFits (bool isFits)
	set isFits

Protected Attributes
std::shared_ptr< std::istream >	_istreamPtr
	input stream
std::shared_ptr< std::ostream >	_ostreamPtr
	output stream
std::string	_sourceStr
	string containing a local copy of sourced data, so source can return a char * that won't disappear right away
bool	_isFits
	is this a FITS stream?

Detailed Description

File-based source or sink (not both) for channels.

Definition at line 142 of file Stream.h.

Constructor & Destructor Documentation

FileStream()

ast::FileStream::FileStream ( std::string const & path, bool doWrite = false )

inlineexplicit

Construct a FileStream for reading or writing, but not both.

Parameters

[in]	path	Path to file as a string
[in]	doWrite	If true then write to the file, otherwise read from the file

Definition at line 150 of file Stream.h.

~FileStream()

virtual ast::FileStream::~FileStream ( )

inlinevirtual

Definition at line 165 of file Stream.h.

Member Function Documentation

getIsFits()

bool ast::Stream::getIsFits ( ) const

inlineinherited

get isfits

Definition at line 125 of file Stream.h.

getPath()

std::string ast::FileStream::getPath ( ) const

inline

Get the path to the file, as a string.

Definition at line 168 of file Stream.h.

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.

setIsFits()

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

inlineprotectedinherited

set isFits

Definition at line 129 of file Stream.h.

sink()

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

inlineinherited

Sink (write) to the stream.

Parameters

[in]

cstr

data 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.

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.

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:

• include/astshim/Stream.h