Main Page | Modules | Class Hierarchy | Class List | File List | Class Members | File Members

Easdif::SelectionSet< TYPE > Class Template Reference
[SDIFEntity - Selection]

A class describing the SDIF selections. More...

#include <sdifentity.hpp>

Inheritance diagram for Easdif::SelectionSet< TYPE >:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 SelectionSet (std::set< TYPE > &inset, bool _open=false)
 create a selection set
bool isActive () const
 Test whether a selection has been established.
bool isOpen () const
 test for open set
void setOpen ()
 make an open selection
bool isSelected (const TYPE inType) const
 test whether element is selected
std::pair< typename std::set<
TYPE >::iterator, bool > 
insert (const TYPE &__x)
 add an element into the selection set
std::set< TYPE >::iterator insert (typename std::set< TYPE >::iterator __position, const TYPE &__x)
 add an element into the selection set
template<class _InputIterator>
void insert (_InputIterator __first, _InputIterator __last)
 add an element into the selection set
void clear (bool deactivate=true)
 clear the selection

Detailed Description

template<class TYPE>
class Easdif::SelectionSet< TYPE >

A class describing the SDIF selections.

This class contains aset of selected entities and a boolean. It is necessary due to the fact that a secltion resulting from the SDIFEntity::RestrictMatrixSelection() SDIFEntity::RestrictFrameSelection(), or SDIFEntity::RestrictStramSelection() calls may be an empty selection, while an empty selection in SDIF means nothing is selected.


Member Function Documentation

template<class TYPE>
bool Easdif::SelectionSet< TYPE >::isActive  )  const [inline]
 

Test whether a selection has been established.

If the selection has been established (function returns true) the entities in the set are used to filter the sdif data. The data returned by ReadNextSelectedFrame wil contain only those elements that match the values in the selected set. If no selection has been established the set is not used to filter data.

The test for an empty selection (which will not pass any data is)

     SdifSelection<TYPE> sel; 
     sel.isActive() && sel.empty()

Returns:
indicates whether selection set is used to filter data


The documentation for this class was generated from the following file:
Generated on Tue Jan 3 15:00:56 2006 for Easdif by  doxygen 1.3.9.1