FemtoScan Online SDK Documentation

Provides STL-based list with search capabilities.

Values are indexed by names of type std::string (keys).

Source:

../fmutl/keylist.h:17

Author:

ATC

Version:

1.0

Param:

T	list value type.

Entity	Type	Scope	Short Description
~key_list	destructor	public	automatically generated
key_list	constructor	public	automatically generated
key_list	constructor	public	automatically generated
add	method	public	Adds empty elemet.
find	method	public	Searches for list element by given key.
find	method	public	Searches for list element by given key.
null	method	public	Get null element.
operator =	operator	public	automatically generated
operator []	operator	public	Searches for list element by given key.
operator []	operator	public	Searches for list element by given key.
remove	method	public	Remove elemet.
string_find	struct	protected	Used to perform search procedures in key_list .
value_type	typedef	public	Basic list element type.

automatically generated

Source:

../fmutl/keylist.h

Code:

public ~ key_list ( )

automatically generated

Source:

../fmutl/keylist.h

Code:

public key_list (

)

automatically generated

Source:

../fmutl/keylist.h

Code:

public key_list (

const key_list & )

Adds empty elemet.

Source:

../fmutl/keylist.h:104

Param:

key	element's key.

Returns:

if element already exists, reference to list element of type T , else inserts T() with given key and returns it's reference.

Code:

public T & add (

const std::string & key )

Searches for list element by given key.

Source:

../fmutl/keylist.h:55

Param:

key	element's key.

Returns:

if found, iterator to list element of type value_type , else end().

Code:

public std::list < std::pair < std::string , T > >::iterator find (

const std::string & key )

Searches for list element by given key.

Source:

../fmutl/keylist.h:63

See Also:

find

Code:

public std::list < std::pair < std::string , T > >::const_iterator find (

const std::string & key ) const

Get null element.

Get refenrence to the list's null element (for comparison).

Source:

../fmutl/keylist.h:121

Returns:

null element.

Code:

public const T & null (

)

automatically generated

Source:

../fmutl/keylist.h

Code:

public key_list & operator = (

const key_list & )

Searches for list element by given key.

Source:

../fmutl/keylist.h:77

Param:

key	element's key.

Returns:

if found, reference to list element of type T , else returns null element.

Code:

public T & operator [] (

const std::string & key )

Searches for list element by given key.

Source:

../fmutl/keylist.h:91

Param:

key	element's key.

Returns:

if found, const reference to list element of type T , else returns null element.

Code:

public const T & operator [] (

const std::string & key ) const

Remove elemet.

Source:

../fmutl/keylist.h:114

Param:

key	element's key.

Code:

public void remove (

const std::string & key )

Used to perform search procedures in key_list .

Source:

../fmutl/keylist.h:23

Code:

protected struct string_find : std::unary_function < std::pair < std::string , T > , bool >

Basic list element type.

Source:

../fmutl/keylist.h:45

Code:

public typedef std::pair < std::string , T > value_type

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