Class template for common base class. More...

#include <pstream.h>

Inheritance diagram for redi::pstream_common< CharT, Traits >:

Public Member Functions
int	close ()

bool	is_open () const
	Report whether the stream's buffer has been initialised. More...

const std::string &	command () const
	Return the command used to initialise the stream. More...

streambuf_type *	rdbuf () const
	Return a pointer to the stream buffer. More...

Protected Types
typedef basic_pstreambuf< CharT, Traits >	streambuf_type

typedef std::basic_ios< CharT, Traits >	ios_type

typedef pstreams::pmode	pmode

typedef pstreams::argv_type	argv_type

Protected Types inherited from redi::pstreams
enum	{ bufsz = 32 }

enum	{ pbsz = 2 }

Protected Member Functions
	pstream_common ()
	Default constructor. More...

	pstream_common (const std::string &cmd, pmode mode)
	Constructor that initialises the stream by starting a process. More...

	pstream_common (const std::string &file, const argv_type &argv, pmode mode)
	Constructor that initialises the stream by starting a process. More...

virtual	~pstream_common ()=0
	Pure virtual destructor. More...

void	do_open (const std::string &cmd, pmode mode)
	Start a process. More...

void	do_open (const std::string &file, const argv_type &argv, pmode mode)
	Start a process. More...

Protected Attributes
std::string	command_
	The command used to start the process. More...

streambuf_type	buf_
	The stream buffer. More...

Additional Inherited Members
Public Types inherited from redi::pstreams
typedef std::ios_base::openmode	pmode
	Type used to specify how to connect to the process. More...

typedef std::vector< std::string >	argv_type
	Type used to hold the arguments for a command. More...

typedef int	fd_type
	Type used for file descriptors. More...

Static Public Attributes inherited from redi::pstreams
static const pmode	pstdin = std::ios_base::out
	Write to stdin. More...

static const pmode	pstdout = std::ios_base::in
	Read from stdout. More...

static const pmode	pstderr = std::ios_base::app
	Read from stderr. More...

static const pmode	newpg = std::ios_base::trunc
	Create a new process group for the child process. More...

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>>
class redi::pstream_common< CharT, Traits >

Class template for common base class.

Abstract Base Class providing common functionality for basic_ipstream, basic_opstream and basic_pstream. pstream_common manages the basic_pstreambuf stream buffer that is used by the derived classes to initialise an iostream class.

Member Typedef Documentation

◆ argv_type

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef pstreams::argv_type redi::pstream_common< CharT, Traits >::argv_type

protected

◆ ios_type

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef std::basic_ios<CharT, Traits> redi::pstream_common< CharT, Traits >::ios_type

protected

◆ pmode

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef pstreams::pmode redi::pstream_common< CharT, Traits >::pmode

protected

◆ streambuf_type

template<typename CharT , typename Traits = std::char_traits<CharT>>

typedef basic_pstreambuf<CharT, Traits> redi::pstream_common< CharT, Traits >::streambuf_type

protected

Constructor & Destructor Documentation

◆ pstream_common() [1/3]

template<typename C , typename T >

redi::pstream_common< C, T >::pstream_common ( )

inlineprotected

Default constructor.

Creates an uninitialised stream.

◆ pstream_common() [2/3]

template<typename C , typename T >

redi::pstream_common< C, T >::pstream_common	(	const std::string &	cmd,
		pmode	mode
	)

inlineprotected

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_open( command , mode )

Parameters

cmd	a string containing a shell command.
mode	the I/O mode to use when opening the pipe.

See also: do_open(const std::string&, pmode)

◆ pstream_common() [3/3]

template<typename C , typename T >

redi::pstream_common< C, T >::pstream_common	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

inlineprotected

Constructor that initialises the stream by starting a process.

Initialises the stream buffer by calling do_open( file , argv , mode )

Parameters

file	a string containing the pathname of a program to execute.
argv	a vector of argument strings passed to the new program.
mode	the I/O mode to use when opening the pipe.

See also: do_open(const std::string&, const argv_type&, pmode)

◆ ~pstream_common()

template<typename C , typename T >

redi::pstream_common< C, T >::~pstream_common ( )

inlineprotectedpure virtual

Pure virtual destructor.

This is a pure virtual function to make pstream_common abstract. Because it is the destructor it will be called by derived classes and so must be defined. It is also protected, to discourage use of the PStreams classes through pointers or references to the base class.

See also: If defining a pure virtual seems odd you should read http://www.gotw.ca/gotw/031.htm (and the rest of the site as well!)

Member Function Documentation

◆ close()

template<typename C , typename T >

int redi::pstream_common< C, T >::close ( )

inline

Close the pipe, returning the program's exit status, as pclose(3) does.

Calls rdbuf->close() and sets failbit on error. Returns process's exit status, as pclose(3) does.

◆ command()

template<typename C , typename T >

const std::string & redi::pstream_common< C, T >::command ( ) const

inline

Return the command used to initialise the stream.

Returns: a string containing the command used to initialise the stream.

◆ do_open() [1/2]

template<typename C , typename T >

void redi::pstream_common< C, T >::do_open	(	const std::string &	cmd,
		pmode	mode
	)

inlineprotected

Start a process.

Calls rdbuf()->open( command , mode ) and sets failbit on error.

Parameters

cmd	a string containing a shell command.
mode	the I/O mode to use when opening the pipe.

See also: basic_pstreambuf::open(const std::string&, pmode)

◆ do_open() [2/2]

template<typename C , typename T >

void redi::pstream_common< C, T >::do_open	(	const std::string &	file,
		const argv_type &	argv,
		pmode	mode
	)

inlineprotected

Start a process.

Calls rdbuf()->open( file, argv, mode ) and sets failbit on error.

Parameters

file	a string containing the pathname of a program to execute.
argv	a vector of argument strings passed to the new program.
mode	the I/O mode to use when opening the pipe.

See also: basic_pstreambuf::open(const std::string&, const argv_type&, pmode)

◆ is_open()

template<typename C , typename T >

bool redi::pstream_common< C, T >::is_open ( ) const

inline

Report whether the stream's buffer has been initialised.

Returns: rdbuf()->is_open().

See also: basic_pstreambuf::is_open()

◆ rdbuf()

template<typename C , typename T >

pstream_common< C, T >::streambuf_type * redi::pstream_common< C, T >::rdbuf ( ) const

inline

Return a pointer to the stream buffer.

Returns: a pointer to the private stream buffer member.

Member Data Documentation

◆ buf_

template<typename CharT , typename Traits = std::char_traits<CharT>>

streambuf_type redi::pstream_common< CharT, Traits >::buf_

protected

The stream buffer.

◆ command_

template<typename CharT , typename Traits = std::char_traits<CharT>>

std::string redi::pstream_common< CharT, Traits >::command_

protected

The command used to start the process.

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

/home/trekirk/ROS/catkin_dev/src/acoustic_touch_recognition/include/pstreams/pstream.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<typename CharT, typename Traits = std::char_traits<CharT>> class redi::pstream_common< CharT, Traits >

Member Typedef Documentation

◆ argv_type

◆ ios_type

◆ pmode

◆ streambuf_type

Constructor & Destructor Documentation

◆ pstream_common() [1/3]

◆ pstream_common() [2/3]

◆ pstream_common() [3/3]

◆ ~pstream_common()

Member Function Documentation

◆ close()

◆ command()

◆ do_open() [1/2]

◆ do_open() [2/2]

◆ is_open()

◆ rdbuf()

Member Data Documentation

◆ buf_

◆ command_

template<typename CharT, typename Traits = std::char_traits<CharT>>
class redi::pstream_common< CharT, Traits >