OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.
    Open CASCADE Technology Reference Manual 8.0.1
    TDF_ComparisonTool Class Reference

    This class provides services to compare sets of information. The use of this tool can works after a copy, acted by a CopyTool. More...

    #include <TDF_ComparisonTool.hxx>

    Static Public Member Functions

    static void Compare (const occ::handle< TDF_DataSet > &aSourceDataSet, const occ::handle< TDF_DataSet > &aTargetDataSet, const TDF_IDFilter &aFilter, const occ::handle< TDF_RelocationTable > &aRelocationTable)
     Compares <aSourceDataSet> with <aTargetDataSet>, updating <aRelocationTable> with labels and attributes found in both sets.
    static bool SourceUnbound (const occ::handle< TDF_DataSet > &aRefDataSet, const occ::handle< TDF_RelocationTable > &aRelocationTable, const TDF_IDFilter &aFilter, const occ::handle< TDF_DataSet > &aDiffDataSet, const int anOption=2)
     Finds from <aRefDataSet> all the keys not bound into <aRelocationTable> and put them into <aDiffDataSet>. Returns True if the difference contains at least one key. (A key is a source object).
    static bool TargetUnbound (const occ::handle< TDF_DataSet > &aRefDataSet, const occ::handle< TDF_RelocationTable > &aRelocationTable, const TDF_IDFilter &aFilter, const occ::handle< TDF_DataSet > &aDiffDataSet, const int anOption=2)
     Subtracts from <aRefDataSet> all the items bound into <aRelocationTable>. The result is put into <aDiffDataSet>. Returns True if the difference contains at least one item. (An item is a target object).
    static void Cut (const occ::handle< TDF_DataSet > &aDataSet)
     Removes attributes from <aDataSet>.
    static bool IsSelfContained (const TDF_Label &aLabel, const occ::handle< TDF_DataSet > &aDataSet)
     Returns true if all the labels of <aDataSet> are descendant of <aLabel>.

    Detailed Description

    This class provides services to compare sets of information. The use of this tool can works after a copy, acted by a CopyTool.

    • Compare(...) compares two DataSet and returns the result.
    • SourceUnbound(...) builds the difference between a relocation dictionary and a source set of information.
    • TargetUnbound(...) does the same between a relocation dictionary and a target set of information.
    • Cut(aDataSet, anLabel) removes a set of attributes.
    • IsSelfContained(...) returns true if all the labels of the attributes of the given DataSet are descendant of the given label.

    Member Function Documentation

    ◆ Compare()

    void TDF_ComparisonTool::Compare ( const occ::handle< TDF_DataSet > & aSourceDataSet,
    const occ::handle< TDF_DataSet > & aTargetDataSet,
    const TDF_IDFilter & aFilter,
    const occ::handle< TDF_RelocationTable > & aRelocationTable )
    		static

    Compares <aSourceDataSet> with <aTargetDataSet>, updating <aRelocationTable> with labels and attributes found in both sets.

    ◆ Cut()

    void TDF_ComparisonTool::Cut ( const occ::handle< TDF_DataSet > & aDataSet)
    		static

    Removes attributes from <aDataSet>.

    ◆ IsSelfContained()

    bool TDF_ComparisonTool::IsSelfContained ( const TDF_Label & aLabel,
    const occ::handle< TDF_DataSet > & aDataSet )
    		static

    Returns true if all the labels of <aDataSet> are descendant of <aLabel>.

    ◆ SourceUnbound()

    bool TDF_ComparisonTool::SourceUnbound ( const occ::handle< TDF_DataSet > & aRefDataSet,
    const occ::handle< TDF_RelocationTable > & aRelocationTable,
    const TDF_IDFilter & aFilter,
    const occ::handle< TDF_DataSet > & aDiffDataSet,
    const int anOption = 2 )
    		static

    Finds from <aRefDataSet> all the keys not bound into <aRelocationTable> and put them into <aDiffDataSet>. Returns True if the difference contains at least one key. (A key is a source object).

    <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only (default value); 3 : both labels & attributes treatment.

    ◆ TargetUnbound()

    bool TDF_ComparisonTool::TargetUnbound ( const occ::handle< TDF_DataSet > & aRefDataSet,
    const occ::handle< TDF_RelocationTable > & aRelocationTable,
    const TDF_IDFilter & aFilter,
    const occ::handle< TDF_DataSet > & aDiffDataSet,
    const int anOption = 2 )
    		static

    Subtracts from <aRefDataSet> all the items bound into <aRelocationTable>. The result is put into <aDiffDataSet>. Returns True if the difference contains at least one item. (An item is a target object).

    <anOption> may take the following values: 1 : labels treatment only; 2 : attributes treatment only (default value); 3 : both labels & attributes treatment.

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