#include <sound.h>

Inheritance diagram for PSoundChannelEmulation:

Collaboration diagram for PSoundChannelEmulation:

Public Member Functions
	PSoundChannelEmulation ()

virtual PBoolean	Close ()
	Close the channel. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual PBoolean	SetFormat (unsigned numChannels, unsigned sampleRate, unsigned bitsPerSample)
	Set the format for play/record. More...

virtual unsigned	GetChannels () const
	Get the number of channels (mono/stereo) in the sound. More...

virtual unsigned	GetSampleRate () const
	Get the sample rate in samples per second. More...

virtual unsigned	GetSampleSize () const
	Get the sample size in bits per sample. More...

virtual PBoolean	SetBuffers (PINDEX size, PINDEX)
	Set the internal buffers for the sound channel I/O. More...

virtual PBoolean	GetBuffers (PINDEX &size, PINDEX &count)
	Get the internal buffers for the sound channel I/O. More...

virtual PBoolean	HasPlayCompleted ()
	Indicate if the sound play begun with PlayBuffer() or PlayFile() has completed. More...

virtual PBoolean	WaitForPlayCompletion ()
	Block calling thread until the sound play begun with PlaySound() or PlayFile() has completed. More...

virtual PBoolean	StartRecording ()
	Start filling record buffers. More...

virtual PBoolean	IsRecordBufferFull ()
	Determine if a record buffer has been filled, so that the next Read() call will not block. More...

virtual PBoolean	AreAllRecordBuffersFull ()
	Determine if all of the record buffer allocated has been filled. More...

virtual PBoolean	WaitForRecordBufferFull ()
	Block the thread until a record buffer has been filled, so that the next Read() call will not block. More...

virtual PBoolean	WaitForAllRecordBuffersFull ()
	Block the thread until all of the record buffer allocated has been filled. More...

virtual PBoolean	SetVolume (unsigned volume)
	Set the volume of the play/read process. More...

virtual PBoolean	GetVolume (unsigned &volume)
	Get the volume of the play/read process. More...

virtual bool	SetMute (bool mute)
	Set the mute state of the play/read process. More...

virtual bool	GetMute (bool &mute)
	Get the mute state of the play/read process. More...

Public Member Functions inherited from PSoundChannel
	P_DECLARE_STREAMABLE_ENUM (Directions, Recorder, Player, Closed)

	PSoundChannel ()
	Create a sound channel. More...

	PSoundChannel (const Params &params)
	Create a sound channel. More...

	PSoundChannel (const PString &device, Directions dir, unsigned numChannels=1, unsigned sampleRate=8000, unsigned bitsPerSample=16)

virtual bool	Open (const Params &params)
	Open the specified device for playing or recording. More...

bool	Open (const PString &device, Directions dir, unsigned numChannels=1, unsigned sampleRate=8000, unsigned bitsPerSample=16, PPluginManager *pluginMgr=NULL)

Directions	GetDirection () const
	Get the direction of the channel. More...

virtual const char *	GetDirectionText () const
	Get text representing the direction of the channel. More...

virtual PBoolean	Abort ()
	Abort the background playing/recording of the sound channel. More...

virtual PBoolean	PlaySound (const PSound &sound, PBoolean wait=true)
	Play a sound to the open device. More...

virtual bool	PlayFile (const PFilePath &file, bool wait=true, unsigned volume=100)
	Play a sound file to the open device. More...

virtual PBoolean	RecordSound (PSound &sound)
	Record into the sound object all of the buffer's of sound data. More...

virtual PBoolean	RecordFile (const PFilePath &file)
	Record into the platform dependent sound file all of the buffer's of sound data. More...

Public Member Functions inherited from PIndirectChannel
	PIndirectChannel ()
	Create a new indirect channel without any channels to redirect to. More...

	~PIndirectChannel ()
	Close the indirect channel, deleting read/write channels if desired. More...

Comparison	Compare (const PObject &obj) const
	Determine if the two objects refer to the same indirect channel. More...

virtual PString	GetName () const
	Get the name of the channel. More...

virtual P_INT_PTR	GetHandle () const
	Get the OS specific handle for the PSoundChannel. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open and read and write operations can be executed on it. More...

virtual int	ReadChar ()
	Read a single character from the channel. More...

virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a channel. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual PChannel *	GetBaseReadChannel () const
	This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual PChannel *	GetBaseWriteChannel () const
	This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

PBoolean	Open (PChannel &channel)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel *channel, PBoolean autoDelete=true)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel readChannel, PChannel writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
	Set the channel for both read and write operations. More...

PChannel *	Detach (ShutdownValue option=ShutdownReadAndWrite)
	Detach without closing the read/write channel. More...

PChannel *	GetReadChannel () const
	Get the channel used for read operations. More...

bool	SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

PChannel *	GetWriteChannel () const
	Get the channel used for write operations. More...

PBoolean	SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

template<class ChannelClass >
ChannelClass *	FindChannel ()
	Locate a channel of a specific class in the indirect chain. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual bool	RawWrite (const void *data, PINDEX size)

virtual bool	RawRead (void *data, PINDEX size)

virtual bool	Rewind ()

bool	InternalFlush ()

	PDECLARE_MUTEX (m_writeMutex)

Protected Member Functions inherited from PSoundChannel
PSoundChannel *	GetSoundChannel () const

	P_REMOVE_VIRTUAL (PBoolean, Open(const PString &, Directions, unsigned, unsigned, unsigned), false)

Protected Member Functions inherited from PIndirectChannel
virtual PBoolean	OnOpen ()
	This callback is executed when the Open() function is called with open channels. More...

	PDECLARE_READ_WRITE_MUTEX (channelPointerMutex)
	Race condition prevention on closing channel. More...

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

virtual int	os_errno () const

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
unsigned	m_sampleRate

unsigned	m_channels

unsigned	m_bytesPerSample

unsigned	m_bufferSize

unsigned	m_bufferCount

PINDEX	m_bufferPos

PBYTEArray	m_buffer

bool	m_autoRepeat

PAdaptiveDelay	m_Pacing

bool	m_muted

Protected Attributes inherited from PSoundChannel
Directions	m_activeDirection
	This is the direction that this sound channel is opened for use in. More...

Protected Attributes inherited from PIndirectChannel
PChannel *	readChannel
	Channel for read operations. More...

PBoolean	readAutoDelete
	Automatically delete read channel on destruction. More...

PChannel *	writeChannel
	Channel for write operations. More...

PBoolean	writeAutoDelete
	Automatically delete write channel on destruction. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PSoundChannel
enum	{ DefaultBufferSize = 320, DefaultBufferCount = 2 }

enum	{ MaxVolume = 100 }

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PSoundChannel
static PStringArray	GetDriverNames (PPluginManager *pluginMgr=NULL)
	Get the list of available sound drivers (plug-ins) More...

static PStringArray	GetDriversDeviceNames (const PString &driverName, Directions direction, PPluginManager *pluginMgr=NULL)
	Get sound devices that correspond to the specified driver name. More...

static PStringArray	GetDeviceNames (const PString &driverName, Directions direction, PPluginManager *pluginMgr=NULL)

static PSoundChannel *	CreateChannel (const PString &driverName, PPluginManager *pluginMgr=NULL)
	Create the sound channel that corresponds to the specified driver name. More...

static PSoundChannel *	CreateChannelByName (const PString &deviceName, Directions direction, PPluginManager *pluginMgr=NULL)

static PSoundChannel *	CreateOpenedChannel (const Params &params)
	Create an opened sound channel that corresponds to the specified names. More...

static PSoundChannel *	CreateOpenedChannel (const PString &driverName, const PString &deviceName, Directions direction, unsigned numChannels=1, unsigned sampleRate=8000, unsigned bitsPerSample=16, PPluginManager *pluginMgr=NULL)

static PString	GetDefaultDevice (Directions dir)
	Get the name for the default sound devices/driver that is on this platform. More...

static PStringArray	GetDeviceNames (Directions direction, PPluginManager *pluginMgr=NULL)
	Get the list of all devices name for the default sound devices/driver that is on this platform. More...

static const char *	GetDirectionText (Directions dir)
	Get text representing the direction of a channel. More...

static PString	TestPlayer (const Params &params, const PNotifier &progress=PNotifier(), const char *toneSpec=NULL)
	Test the specified device for playing. More...

static PString	TestRecorder (const Params &recorderParams, const Params &playerParams, const PNotifier &progress=PNotifier(), unsigned seconds=5)
	Test the specified device for playing. More...

Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Constructor & Destructor Documentation

PSoundChannelEmulation::PSoundChannelEmulation ( )

Member Function Documentation

virtual PBoolean PSoundChannelEmulation::AreAllRecordBuffersFull ( )

virtual

Determine if all of the record buffer allocated has been filled.

There is an implicit Abort() of the recording if this occurs and recording is stopped. The channel may need to be closed and opened again to start a new recording.

Returns: true if the sound driver has filled a buffer.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::Close ( )

virtual

Close the channel.

This will detach itself from the read and write channels and delete both of them if they are auto delete.

Returns: true if the channel is closed.

Reimplemented from PIndirectChannel.

virtual PBoolean PSoundChannelEmulation::GetBuffers	(	PINDEX &	size,
		PINDEX &	count
	)

virtual

Get the internal buffers for the sound channel I/O.

Returns: true if the buffer size were obtained.

Reimplemented from PSoundChannel.

virtual unsigned PSoundChannelEmulation::GetChannels ( ) const

virtual

Get the number of channels (mono/stereo) in the sound.

Reimplemented from PSoundChannel.

virtual bool PSoundChannelEmulation::GetMute ( bool & mute )

virtual

Get the mute state of the play/read process.

Returns: true if there were no errors.

Reimplemented from PSoundChannel.

virtual unsigned PSoundChannelEmulation::GetSampleRate ( ) const

virtual

Get the sample rate in samples per second.

Reimplemented from PSoundChannel.

virtual unsigned PSoundChannelEmulation::GetSampleSize ( ) const

virtual

Get the sample size in bits per sample.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::GetVolume ( unsigned & volume )

virtual

Get the volume of the play/read process.

The volume range is 0 == muted, 100 == LOUDEST. The volume is a logarithmic scale mapped from the lowest gain possible on the device to the highest gain.

Returns: true if there were no errors.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::HasPlayCompleted ( )

virtual

Indicate if the sound play begun with PlayBuffer() or PlayFile() has completed.

Returns: true if the sound has completed playing.

Reimplemented from PSoundChannel.

bool PSoundChannelEmulation::InternalFlush ( )

protected

virtual PBoolean PSoundChannelEmulation::IsRecordBufferFull ( )

virtual

Determine if a record buffer has been filled, so that the next Read() call will not block.

Provided that the amount of data read is less than the buffer size.

Returns: true if the sound driver has filled a buffer.

Reimplemented from PSoundChannel.

PSoundChannelEmulation::PDECLARE_MUTEX ( m_writeMutex )

protected

virtual bool PSoundChannelEmulation::RawRead	(	void *	data,
		PINDEX	size
	)

protectedvirtual

virtual bool PSoundChannelEmulation::RawWrite	(	const void *	data,
		PINDEX	size
	)

protectedvirtual

virtual PBoolean PSoundChannelEmulation::Read	(	void *	buf,
		PINDEX	len
	)

virtual

Low level read from the channel.

This function may block until the requested number of characters were read or the read timeout was reached. The GetLastReadCount() function returns the actual number of bytes read.

This will use the readChannel pointer to actually do the read. If readChannel is null the this asserts.

The GetErrorCode() function should be consulted after Read() returns false to determine what caused the failure.

Returns: true indicates that at least one character was read from the channel. false means no bytes were read due to timeout or some other I/O error.

Reimplemented from PIndirectChannel.

virtual bool PSoundChannelEmulation::Rewind ( )

protectedvirtual

virtual PBoolean PSoundChannelEmulation::SetBuffers	(	PINDEX	size,
		PINDEX	count
	)

virtual

Set the internal buffers for the sound channel I/O.

Note that with Linux OSS, the size is always rounded up to the nearest power of two, so 20000 => 32768.

Returns: true if the sound device is valid for playing/recording.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::SetFormat	(	unsigned	numChannels,
		unsigned	sampleRate,
		unsigned	bitsPerSample
	)

virtual

Set the format for play/record.

Note that linear PCM data is the only one supported at this time.

Note that if the PlayFile() function is used, this may be overridden by information in the file being played.

Returns: true if the format is valid.

Reimplemented from PSoundChannel.

virtual bool PSoundChannelEmulation::SetMute ( bool mute )

virtual

Set the mute state of the play/read process.

Returns: true if there were no errors.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::SetVolume ( unsigned volume )

virtual

Set the volume of the play/read process.

The volume range is 0 == muted, 100 == LOUDEST. The volume is a logarithmic scale mapped from the lowest gain possible on the device to the highest gain.

Returns: true if there were no errors.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::StartRecording ( )

virtual

Start filling record buffers.

The first call to Read() will also initiate the recording.

Returns: true if the sound driver has successfully started recording.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::WaitForAllRecordBuffersFull ( )

virtual

Block the thread until all of the record buffer allocated has been filled.

There is an implicit Abort() of the recording if this occurs and recording is stopped. The channel may need to be closed and opened again to start a new recording.

Returns: true if the sound driver has filled a buffer.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::WaitForPlayCompletion ( )

virtual

Block calling thread until the sound play begun with PlaySound() or PlayFile() has completed.

Returns: true if the sound has successfully completed playing.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::WaitForRecordBufferFull ( )

virtual

Block the thread until a record buffer has been filled, so that the next Read() call will not block.

Provided that the amount of data read is less than the buffer size.

Returns: true if the sound driver has filled a buffer.

Reimplemented from PSoundChannel.

virtual PBoolean PSoundChannelEmulation::Write	(	const void *	buf,
		PINDEX	len
	)

virtual

Low level write to the channel.

This function will block until the requested number of characters are written or the write timeout is reached. The GetLastWriteCount() function returns the actual number of bytes written.

This will use the writeChannel pointer to actually do the write. If writeChannel is null the this asserts.

The GetErrorCode() function should be consulted after Write() returns false to determine what caused the failure.

Returns: true if at least len bytes were written to the channel.

Reimplemented from PIndirectChannel.

Member Data Documentation

bool PSoundChannelEmulation::m_autoRepeat

protected

PBYTEArray PSoundChannelEmulation::m_buffer

protected

unsigned PSoundChannelEmulation::m_bufferCount

protected

PINDEX PSoundChannelEmulation::m_bufferPos

protected

unsigned PSoundChannelEmulation::m_bufferSize

protected

unsigned PSoundChannelEmulation::m_bytesPerSample

protected

unsigned PSoundChannelEmulation::m_channels

protected

bool PSoundChannelEmulation::m_muted

protected

PAdaptiveDelay PSoundChannelEmulation::m_Pacing

protected

unsigned PSoundChannelEmulation::m_sampleRate

protected

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

sound.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation