FemtoScan Online SDK Documentation

STL-based FIFO queue implementation.

This queue provides mechanisms for thread-safe operation over it's members. Intended for usage with MessageType class.

Source:

../fsio/SPMQueue.h:24

Author:

ATC

Version:

1.0

Entity	Type	Scope	Short Description
~SPMQueue	destructor	public	Standart destructor.
SPMQueue	constructor	public	Default constructor.
SPMQueue	constructor	public	Copy constructor.
ClearData	method	public	Clear all elements.
GetData	method	public	Get oldest object and remove it from queue.
GetTotalSize	method	public	Get number of elements in queue.
HaveData	method	public	Check if queue is not empty.
operator =	operator	public	Copy operator.
SetData	method	public	Insert object in queue.

Standart destructor.

Source:

../fsio/SPMQueue.h:48

Code:

public virtual ~ SPMQueue ( )

Default constructor.

Source:

../fsio/SPMQueue.h:30

Code:

public SPMQueue (

)

Copy constructor.

Source:

../fsio/SPMQueue.h:36

Param:

Q	queue to copy

Code:

public SPMQueue (

const SPMQueue & Q )

Clear all elements.

Source:

../fsio/SPMQueue.h:78

Code:

public void ClearData (

)

Get oldest object and remove it from queue.

Source:

../fsio/SPMQueue.h:61

Param:

Data	the object where to put copy of removed element.

Returns:

false if no more elements in queue.

Code:

public bool GetData (

T & Data )

Get number of elements in queue.

Source:

../fsio/SPMQueue.h:73

Returns:

number of elements in queue.

Code:

public unsigned GetTotalSize (

)

Check if queue is not empty.

Source:

../fsio/SPMQueue.h:67

Returns:

true if queue is not empty

Code:

public bool HaveData (

)

Copy operator.

Source:

../fsio/SPMQueue.h:43

Param:

Q	queue to copy.

Returns:

reference to modifyed object (*this).

Code:

public SPMQueue & operator = (

const SPMQueue & Q )

Insert object in queue.

Source:

../fsio/SPMQueue.h:54

Param:

Data	the object to insert.

Code:

public void SetData (

const T & Data )

(C) Advanced Technologies Center, 2002-2006
For support contact us at fsdev@nanoscopy.net