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

SDIFEntity - Selection

functions related to handle the sdif data selections More...

Classes

class  Easdif::SelectionSet< TYPE >
 A class describing the SDIF selections. More...

Functions

 Easdif::SelectionSet::SelectionSet (std::set< TYPE > &inset, bool _open=false)
 create a selection set
bool Easdif::SelectionSet::isOpen () const
 test for open set
void Easdif::SelectionSet::setOpen ()
 make an open selection
bool Easdif::SelectionSet::isSelected (const TYPE inType) const
 test whether element is selected
std::pair< typename std::set<
TYPE >::iterator, bool > 
Easdif::SelectionSet::insert (const TYPE &__x)
 add an element into the selection set
std::set< TYPE >::iterator Easdif::SelectionSet::insert (typename std::set< TYPE >::iterator __position, const TYPE &__x)
 add an element into the selection set
template<class _InputIterator>
void Easdif::SelectionSet::insert (_InputIterator __first, _InputIterator __last)
 add an element into the selection set
void Easdif::SelectionSet::clear (bool deactivate=true)
 clear the selection
bool Easdif::SDIFEntity::ChangeSelection (const std::string &selection)
 replace selection for current file
bool Easdif::SDIFEntity::MergeSelection (const std::string &selection)
 merge selection to the selection that is currently active
bool Easdif::SDIFEntity::ClearSelection (Easdif::SDIFEntity::SelectionPartsE part)
 clear part or all of active selection
bool Easdif::SDIFEntity::GetMatrixSelection (SelectionSet< SdifSignature > &out) const
 get the vector of selected matrix signatures that exist for the current file
bool Easdif::SDIFEntity::TestMatrixSelection (SdifSignature sig) const
 test whether a given matrix signature is part of the current selection
bool Easdif::SDIFEntity::GetFrameSelection (SelectionSet< SdifSignature > &out) const
 get the vector of selected frame signatures that exist for the current file
bool Easdif::SDIFEntity::TestFrameSelection (SdifSignature sig) const
 test whether a given frame signature is part of the current selection
bool Easdif::SDIFEntity::GetStreamSelection (SelectionSet< unsigned int > &out) const
 get the set of selected streamid's that exist for the current file
bool Easdif::SDIFEntity::TestStreamSelection (unsigned int streamid) const
 test whether a given streamid is part of the current selection
bool Easdif::SDIFEntity::RestrictFrameSelection (const SelectionSet< SdifSignature > &sigs)
 restrict the frame signature selection
bool Easdif::SDIFEntity::ReestablishFrameSelection ()
 reestablish a previous state of frame signature selection
bool Easdif::SDIFEntity::RestrictMatrixSelection (const SelectionSet< SdifSignature > &sigs)
 restrict the matrix signature selection
bool Easdif::SDIFEntity::ReestablishMatrixSelection ()
 reestablish a previous state of matrix signature selection
bool Easdif::SDIFEntity::RestrictStreamSelection (const SelectionSet< unsigned int > &streamid)
 restrict the streamid selection
bool Easdif::SDIFEntity::ReestablishStreamSelection ()
 reestablish a previous state of stream signature selection

Detailed Description

functions related to handle the sdif data selections


Function Documentation

template<class TYPE>
Easdif::SelectionSet< TYPE >::SelectionSet std::set< TYPE > &  inset,
bool  _open = false
[inline, inherited]
 

create a selection set

if the given list of elements is not empty the selection will be enabled; it is not possible to create a active SelectionSet that has no elements selected (an empty set). Use clear(false) after creation for this.

Parameters:
inset set to copy elements from
_open if given and true this signals all the elements after the last element will be included in the set.
Returns:

template<class TYPE>
bool Easdif::SelectionSet< TYPE >::isOpen  )  const [inline, inherited]
 

test for open set

test for open selection , openselections are only sensible for streamid selection where the < operator makes sense.

Returns:
true if the selection is an open set which means all elements after the last element will be included

template<class TYPE>
void Easdif::SelectionSet< TYPE >::setOpen  )  [inline, inherited]
 

make an open selection

an open selection can be used that all elements after the last element in the selection are selected (makes only snese for stream ids);

template<class TYPE>
bool Easdif::SelectionSet< TYPE >::isSelected const TYPE  inType  )  const [inline, inherited]
 

test whether element is selected

test whether element is selected

Returns:
true if the element is found in the set or the selection is not active, or, for an open selection, the element is larger than the last selected element

template<class TYPE>
std::pair<typename std::set<TYPE>::iterator,bool> Easdif::SelectionSet< TYPE >::insert const TYPE &  __x  )  [inline, inherited]
 

add an element into the selection set

the lement will be added into the selection an the selection will be automatically enabled

Parameters:
__x element to select
Returns:
pair containing iterator to new element and boolean indicating whether element has been added.

template<class TYPE>
std::set<TYPE>::iterator Easdif::SelectionSet< TYPE >::insert typename std::set< TYPE >::iterator  __position,
const TYPE &  __x
[inline, inherited]
 

add an element into the selection set

the element will be added into the selection an the selection will be automatically enabled

Parameters:
__position iterator giving a hint where the element has to be inserted
__x element to select
Returns:
set iterator to new element

template<class TYPE>
template<class _InputIterator>
void Easdif::SelectionSet< TYPE >::insert _InputIterator  __first,
_InputIterator  __last
[inline, inherited]
 

add an element into the selection set

Add range of elements into the set and enable the set.

Parameters:
__first first element to add into the set.
__last after the end element of the arange to add into the set.

template<class TYPE>
void Easdif::SelectionSet< TYPE >::clear bool  deactivate = true  )  [inline, inherited]
 

clear the selection

Parameters:
deactivate if true the selection is cleared and deactivated signaling that no selection is performed. If deactivate is given and false the set is cleared but the selection remains active such that no element is selected.
clear all elements from the set and disable the selection

bool Easdif::SDIFEntity::ChangeSelection const std::string &  selection  )  [inherited]
 

replace selection for current file

Replace current selection by new one given in argument. The selection specification may contain all the parts of a filename based selection after the selection indicator :: .

This function is only allowed if EnableFrameDir() has not yet been called

Parameters:
selection selection string that will be parsed to replace the selection
Returns:
true if success

bool Easdif::SDIFEntity::MergeSelection const std::string &  selection  )  [inherited]
 

merge selection to the selection that is currently active

This function is only allowed if EnableFrameDir() has not been called

Parameters:
selection selection string to merge
Returns:
true if success

bool Easdif::SDIFEntity::ClearSelection Easdif::SDIFEntity::SelectionPartsE  part  )  [inherited]
 

clear part or all of active selection

This function is only allowed if EnableFrameDir() has not been called

Parameters:
part the enum indicating what part of the selection to clear.
Returns:
true if success

bool Easdif::SDIFEntity::GetMatrixSelection SelectionSet< SdifSignature > &  out  )  const [inherited]
 

get the vector of selected matrix signatures that exist for the current file

Parameters:
out vector to be filled with existing selection, empty result indicates no selection, a set containing a single Signature of value eEmptySignature signals that no matrices are selected, which means that only empty frames are read.
Returns:
true if file and returned selection is valid.

bool Easdif::SDIFEntity::TestMatrixSelection SdifSignature  sig  )  const [inherited]
 

test whether a given matrix signature is part of the current selection

Parameters:
sig signature to test
Returns:
true if the given matrix signature is selected (or if no matrix selection exists at all)

bool Easdif::SDIFEntity::GetFrameSelection SelectionSet< SdifSignature > &  out  )  const [inherited]
 

get the vector of selected frame signatures that exist for the current file

Parameters:
out vector to be filled with existing selection, empty result indicates no selection, a set containing a single Signature of value eEmptySignature signals that no frames are selected.
Returns:
true if file and returned selection is valid.

bool Easdif::SDIFEntity::TestFrameSelection SdifSignature  sig  )  const [inherited]
 

test whether a given frame signature is part of the current selection

Parameters:
sig signature to test
Returns:
true if the frame signature is selected (or if no frame selection exists at all)

bool Easdif::SDIFEntity::GetStreamSelection SelectionSet< unsigned int > &  out  )  const [inherited]
 

get the set of selected streamid's that exist for the current file

Parameters:
out vector to be filled with existing selection, empty result indicates no selection, an empty selection that results of an restriction of two incompatible sets will result in a set with a single stream of id SDIFEntity::kEmptyStreamSelection
Returns:
true if file and returned selection is valid.

bool Easdif::SDIFEntity::TestStreamSelection unsigned int  streamid  )  const [inherited]
 

test whether a given streamid is part of the current selection

Parameters:
streamid to test
Returns:
true if the given streamid is selected (or if no matrix selection exists at all)

bool Easdif::SDIFEntity::RestrictFrameSelection const SelectionSet< SdifSignature > &  sigs  )  [inherited]
 

restrict the frame signature selection

The frame selection is updated to contain the intersection between the existing and the given list of signatures. In case the intersection is empty a selection with signature eEmptySignature is established which should not match any valid Frame.

As long as EnableFrameDir() has not been called this function works on the low level SDIF selection, otherwise it establishes a high level selection that can be savely used used with the Directory. The directory will still contain all frames and matrices that are selected accoring to the low level selection.

Parameters:
sigs set of signatures that should remain selected, this set is intersected with any existing Frame selection.
Returns:
true if successful created

bool Easdif::SDIFEntity::ReestablishFrameSelection  )  [inherited]
 

reestablish a previous state of frame signature selection

This function can either be called before or after EnableFrameDir() has been called. In the first case it wil reestablish the frame selection that was initially given as part opf the filename. In the second case it will reestablish the selection that was valid at the time when EnableFrameDir() has been called.

Returns:
true if successful reestablished

bool Easdif::SDIFEntity::RestrictMatrixSelection const SelectionSet< SdifSignature > &  sigs  )  [inherited]
 

restrict the matrix signature selection

The matrix selection is updated to contain the intersection between the existing and the given list of signatures. In case the intersection is empty a selection with signature eEmptySignature is established which should not match any valid matrix.

As long as EnableFrameDir() has not been called this function works on the low level SDIF selection, otherwise it establishes a high level selection that can be savely used used with the Directory. The directory will still contain all frames and matrices that are selected accoring to the low level selection.

Parameters:
sigs set of signatures that should remain selected and that will be intersected with the existing matrix selection.
Returns:
true if successful created

bool Easdif::SDIFEntity::ReestablishMatrixSelection  )  [inherited]
 

reestablish a previous state of matrix signature selection

This function can either be called before or after EnableFrameDir() has been called. In the first case it wil reestablish the frame selection that was initially given as part opf the filename. In the second case it will reestablish the selection that was valid at the time when EnableFrameDir() has been called.

Returns:
true if successful reestablished

bool Easdif::SDIFEntity::RestrictStreamSelection const SelectionSet< unsigned int > &  streamid  )  [inherited]
 

restrict the streamid selection

The stream selection is updated to contain the intersection between the existing and the given list of ids. In case the intersection is empty a selection with signature kEmptyStreamSelection is established which should not match any valid Frame.

As long as EnableFrameDir() has not been called this function works on the low level SDIF selection, otherwise it establishes a high level selection that can be used with the Directory;

Parameters:
streamid set of signatures that should remain selected (ATTENTION OPEN STREAM SELECTIONS NOT YET PROPERLY HANDLED!!)
Returns:
true if successful created

bool Easdif::SDIFEntity::ReestablishStreamSelection  )  [inherited]
 

reestablish a previous state of stream signature selection

This function can either be called before or after EnableFrameDir() has been called. In the first case it wil reestablish the frame selection that was initially given as part opf the filename. In the second case it will reestablish the selection that was valid at the time when EnableFrameDir() has been called.

Returns:
true if successful reestablished


Generated on Tue Jan 3 15:00:56 2006 for Easdif by  doxygen 1.3.9.1