This class offers filtering services around an ID list. More...

#include <TDF_IDFilter.hxx>

Public Member Functions
	TDF_IDFilter (const Standard_Boolean ignoreMode=Standard_True)
	Creates an ID/attribute filter based on an ID list. The default mode is "ignore all but...".

void	IgnoreAll (const Standard_Boolean ignore)
	The list of ID is cleared and the filter mode is set to ignore mode if <keep> is true; false otherwise.

Standard_Boolean	IgnoreAll () const
	Returns true is the mode is set to "ignore all but...".

void	Keep (const Standard_GUID &anID)
	An attribute with <anID> as ID is to be kept and the filter will answer true to the question IsKept(<anID>).

void	Keep (const TDF_IDList &anIDList)
	Attributes with ID owned by <anIDList> are to be kept and the filter will answer true to the question IsKept(<anID>) with ID from <anIDList>.

void	Ignore (const Standard_GUID &anID)
	An attribute with <anID> as ID is to be ignored and the filter will answer false to the question IsKept(<anID>).

void	Ignore (const TDF_IDList &anIDList)
	Attributes with ID owned by <anIDList> are to be ignored and the filter will answer false to the question IsKept(<anID>) with ID from <anIDList>.

Standard_Boolean	IsKept (const Standard_GUID &anID) const
	Returns true if the ID is to be kept.

Standard_Boolean	IsKept (const Handle< TDF_Attribute > &anAtt) const
	Returns true if the attribute is to be kept.

Standard_Boolean	IsIgnored (const Standard_GUID &anID) const
	Returns true if the ID is to be ignored.

Standard_Boolean	IsIgnored (const Handle< TDF_Attribute > &anAtt) const
	Returns true if the attribute is to be ignored.

void	IDList (TDF_IDList &anIDList) const
	Copies the list of ID to be kept or ignored in <anIDList>. <anIDList> is cleared before use.

void	Copy (const TDF_IDFilter &fromFilter)
	Copies into <me> the contents of <fromFilter>. <me> is cleared before copy.

void	Dump (Standard_OStream &anOS) const
	Writes the contents of <me> to <OS>.

void	Assign (const TDF_IDFilter &theFilter)
	Assignment.

Detailed Description

This class offers filtering services around an ID list.

Constructor & Destructor Documentation

◆ TDF_IDFilter()

TDF_IDFilter::TDF_IDFilter ( const Standard_Boolean ignoreMode = Standard_True )

Creates an ID/attribute filter based on an ID list. The default mode is "ignore all but...".

This filter has 2 working mode: keep and ignore.

Ignore/Exclusive mode: all IDs are ignored except these set to be kept, using Keep(). Of course, it is possible set an kept ID to be ignored using Ignore().

Keep/Inclusive mode: all IDs are kept except these set to be ignored, using Ignore(). Of course, it is possible set an ignored ID to be kept using Keep().

Member Function Documentation

◆ Assign()

void TDF_IDFilter::Assign ( const TDF_IDFilter & theFilter )

inline

Assignment.

◆ Copy()

void TDF_IDFilter::Copy ( const TDF_IDFilter & fromFilter )

Copies into <me> the contents of <fromFilter>. <me> is cleared before copy.

◆ Dump()

void TDF_IDFilter::Dump ( Standard_OStream & anOS ) const

Writes the contents of <me> to <OS>.

◆ IDList()

void TDF_IDFilter::IDList ( TDF_IDList & anIDList ) const

Copies the list of ID to be kept or ignored in <anIDList>. <anIDList> is cleared before use.

◆ Ignore() [1/2]

void TDF_IDFilter::Ignore ( const Standard_GUID & anID )

An attribute with <anID> as ID is to be ignored and the filter will answer false to the question IsKept(<anID>).

◆ Ignore() [2/2]

void TDF_IDFilter::Ignore ( const TDF_IDList & anIDList )

Attributes with ID owned by <anIDList> are to be ignored and the filter will answer false to the question IsKept(<anID>) with ID from <anIDList>.

◆ IgnoreAll() [1/2]

Standard_Boolean TDF_IDFilter::IgnoreAll ( ) const

Returns true is the mode is set to "ignore all but...".

◆ IgnoreAll() [2/2]

void TDF_IDFilter::IgnoreAll ( const Standard_Boolean ignore )

The list of ID is cleared and the filter mode is set to ignore mode if <keep> is true; false otherwise.

◆ IsIgnored() [1/2]

Standard_Boolean TDF_IDFilter::IsIgnored ( const Handle< TDF_Attribute > & anAtt ) const

Returns true if the attribute is to be ignored.

◆ IsIgnored() [2/2]

Standard_Boolean TDF_IDFilter::IsIgnored ( const Standard_GUID & anID ) const

Returns true if the ID is to be ignored.

◆ IsKept() [1/2]

Standard_Boolean TDF_IDFilter::IsKept ( const Handle< TDF_Attribute > & anAtt ) const

Returns true if the attribute is to be kept.

◆ IsKept() [2/2]

Standard_Boolean TDF_IDFilter::IsKept ( const Standard_GUID & anID ) const

Returns true if the ID is to be kept.

◆ Keep() [1/2]

void TDF_IDFilter::Keep ( const Standard_GUID & anID )

An attribute with <anID> as ID is to be kept and the filter will answer true to the question IsKept(<anID>).

◆ Keep() [2/2]

void TDF_IDFilter::Keep ( const TDF_IDList & anIDList )

Attributes with ID owned by <anIDList> are to be kept and the filter will answer true to the question IsKept(<anID>) with ID from <anIDList>.

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

TDF_IDFilter.hxx

Public Member Functions