a Finder allows to map any kind of object as a Key for a Map. This works by defining, for a Hash Code, that of the real Key, not of the Finder which acts only as an intermediate. When a Map asks for the HashCode of a Finder, this one returns the code it has determined at creation time More...
#include <Transfer_Finder.hxx>
Public Member Functions | |
| Standard_Integer | GetHashCode () const |
| Returns the HashCode which has been stored by SetHashCode (remark that HashCode could be deferred then be defined by sub-classes, the result is the same) More... | |
| virtual Standard_Boolean | Equates (const Handle< Transfer_Finder > &other) const =0 |
| Specific testof equality : to be defined by each sub-class, must be False if Finders have not the same true Type, else their contents must be compared. More... | |
| virtual Handle< Standard_Type > | ValueType () const |
| Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined. More... | |
| virtual Standard_CString | ValueTypeName () const |
| Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object. More... | |
| void | SetAttribute (const Standard_CString name, const Handle< Standard_Transient > &val) |
| Adds an attribute with a given name (replaces the former one with the same name if already exists) More... | |
| Standard_Boolean | RemoveAttribute (const Standard_CString name) |
| Removes an attribute Returns True when done, False if this attribute did not exist. More... | |
| Standard_Boolean | GetAttribute (const Standard_CString name, const Handle< Standard_Type > &type, Handle< Standard_Transient > &val) const |
| Returns an attribute from its name, filtered by a type If no attribute has this name, or if it is not kind of this type, <val> is Null and returned value is False Else, it is True. More... | |
| Handle< Standard_Transient > | Attribute (const Standard_CString name) const |
| Returns an attribute from its name. Null Handle if not recorded (whatever Transient, Integer, Real ...) More... | |
| Interface_ParamType | AttributeType (const Standard_CString name) const |
| Returns the type of an attribute : ParamInt , ParamReal , ParamText (String) , ParamIdent (any) or ParamVoid (not recorded) More... | |
| void | SetIntegerAttribute (const Standard_CString name, const Standard_Integer val) |
| Adds an integer value for an attribute. More... | |
| Standard_Boolean | GetIntegerAttribute (const Standard_CString name, Standard_Integer &val) const |
| Returns an attribute from its name, as integer If no attribute has this name, or not an integer, <val> is 0 and returned value is False Else, it is True. More... | |
| Standard_Integer | IntegerAttribute (const Standard_CString name) const |
| Returns an integer attribute from its name. 0 if not recorded. More... | |
| void | SetRealAttribute (const Standard_CString name, const Standard_Real val) |
| Adds a real value for an attribute. More... | |
| Standard_Boolean | GetRealAttribute (const Standard_CString name, Standard_Real &val) const |
| Returns an attribute from its name, as real If no attribute has this name, or not a real <val> is 0.0 and returned value is False Else, it is True. More... | |
| Standard_Real | RealAttribute (const Standard_CString name) const |
| Returns a real attribute from its name. 0.0 if not recorded. More... | |
| void | SetStringAttribute (const Standard_CString name, const Standard_CString val) |
| Adds a String value for an attribute. More... | |
| Standard_Boolean | GetStringAttribute (const Standard_CString name, Standard_CString &val) const |
| Returns an attribute from its name, as String If no attribute has this name, or not a String <val> is 0.0 and returned value is False Else, it is True. More... | |
| Standard_CString | StringAttribute (const Standard_CString name) const |
| Returns a String attribute from its name. "" if not recorded. More... | |
| NCollection_DataMap< TCollection_AsciiString, Handle< Standard_Transient > > & | AttrList () |
| Returns the exhaustive list of attributes. More... | |
| void | SameAttributes (const Handle< Transfer_Finder > &other) |
| Gets the list of attributes from <other>, as such, i.e. not copied : attributes are shared, any attribute edited, added, or removed in <other> is also in <me> and vice versa The former list of attributes of <me> is dropped. More... | |
| void | GetAttributes (const Handle< Transfer_Finder > &other, const Standard_CString fromname="", const Standard_Boolean copied=Standard_True) |
| Gets the list of attributes from <other>, by copying it By default, considers all the attributes from <other> If <fromname> is given, considers only the attributes with name beginning by <fromname> More... | |
 Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Protected Member Functions | |
| void | SetHashCode (const Standard_Integer code) |
| Stores the HashCode which corresponds to the Value given to create the Mapper. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
Detailed Description
a Finder allows to map any kind of object as a Key for a Map. This works by defining, for a Hash Code, that of the real Key, not of the Finder which acts only as an intermediate. When a Map asks for the HashCode of a Finder, this one returns the code it has determined at creation time
Member Function Documentation
◆ Attribute()
| Handle< Standard_Transient > Transfer_Finder::Attribute | ( | const Standard_CString | name | ) | const |
Returns an attribute from its name. Null Handle if not recorded (whatever Transient, Integer, Real ...)
◆ AttributeType()
| Interface_ParamType Transfer_Finder::AttributeType | ( | const Standard_CString | name | ) | const |
Returns the type of an attribute : ParamInt , ParamReal , ParamText (String) , ParamIdent (any) or ParamVoid (not recorded)
◆ AttrList()
| NCollection_DataMap<TCollection_AsciiString, Handle< Standard_Transient > >& Transfer_Finder::AttrList | ( | ) |
Returns the exhaustive list of attributes.
◆ Equates()
|
pure virtual |
Specific testof equality : to be defined by each sub-class, must be False if Finders have not the same true Type, else their contents must be compared.
Implemented in TransferBRep_ShapeMapper, TransferBRep_OrientedShapeMapper, and Transfer_TransientMapper.
◆ GetAttribute()
| Standard_Boolean Transfer_Finder::GetAttribute | ( | const Standard_CString | name, |
| const Handle< Standard_Type > & | type, | ||
| Handle< Standard_Transient > & | val | ||
| ) | const |
Returns an attribute from its name, filtered by a type If no attribute has this name, or if it is not kind of this type, <val> is Null and returned value is False Else, it is True.
◆ GetAttributes()
| void Transfer_Finder::GetAttributes | ( | const Handle< Transfer_Finder > & | other, |
| const Standard_CString | fromname = "", |
||
| const Standard_Boolean | copied = Standard_True |
||
| ) |
Gets the list of attributes from <other>, by copying it By default, considers all the attributes from <other> If <fromname> is given, considers only the attributes with name beginning by <fromname>
For each attribute, if <copied> is True (D), its value is also copied if it is a basic type (Integer,Real,String), else it remains shared between <other> and <me>
These new attributes are added to the existing ones in <me>, in case of same name, they replace the existing ones
◆ GetHashCode()
| Standard_Integer Transfer_Finder::GetHashCode | ( | ) | const |
Returns the HashCode which has been stored by SetHashCode (remark that HashCode could be deferred then be defined by sub-classes, the result is the same)
◆ GetIntegerAttribute()
| Standard_Boolean Transfer_Finder::GetIntegerAttribute | ( | const Standard_CString | name, |
| Standard_Integer & | val | ||
| ) | const |
Returns an attribute from its name, as integer If no attribute has this name, or not an integer, <val> is 0 and returned value is False Else, it is True.
◆ GetRealAttribute()
| Standard_Boolean Transfer_Finder::GetRealAttribute | ( | const Standard_CString | name, |
| Standard_Real & | val | ||
| ) | const |
Returns an attribute from its name, as real If no attribute has this name, or not a real <val> is 0.0 and returned value is False Else, it is True.
◆ GetStringAttribute()
| Standard_Boolean Transfer_Finder::GetStringAttribute | ( | const Standard_CString | name, |
| Standard_CString & | val | ||
| ) | const |
Returns an attribute from its name, as String If no attribute has this name, or not a String <val> is 0.0 and returned value is False Else, it is True.
◆ IntegerAttribute()
| Standard_Integer Transfer_Finder::IntegerAttribute | ( | const Standard_CString | name | ) | const |
Returns an integer attribute from its name. 0 if not recorded.
◆ RealAttribute()
| Standard_Real Transfer_Finder::RealAttribute | ( | const Standard_CString | name | ) | const |
Returns a real attribute from its name. 0.0 if not recorded.
◆ RemoveAttribute()
| Standard_Boolean Transfer_Finder::RemoveAttribute | ( | const Standard_CString | name | ) |
Removes an attribute Returns True when done, False if this attribute did not exist.
◆ SameAttributes()
| void Transfer_Finder::SameAttributes | ( | const Handle< Transfer_Finder > & | other | ) |
Gets the list of attributes from <other>, as such, i.e. not copied : attributes are shared, any attribute edited, added, or removed in <other> is also in <me> and vice versa The former list of attributes of <me> is dropped.
◆ SetAttribute()
| void Transfer_Finder::SetAttribute | ( | const Standard_CString | name, |
| const Handle< Standard_Transient > & | val | ||
| ) |
Adds an attribute with a given name (replaces the former one with the same name if already exists)
◆ SetHashCode()
|
protected |
Stores the HashCode which corresponds to the Value given to create the Mapper.
◆ SetIntegerAttribute()
| void Transfer_Finder::SetIntegerAttribute | ( | const Standard_CString | name, |
| const Standard_Integer | val | ||
| ) |
Adds an integer value for an attribute.
◆ SetRealAttribute()
| void Transfer_Finder::SetRealAttribute | ( | const Standard_CString | name, |
| const Standard_Real | val | ||
| ) |
Adds a real value for an attribute.
◆ SetStringAttribute()
| void Transfer_Finder::SetStringAttribute | ( | const Standard_CString | name, |
| const Standard_CString | val | ||
| ) |
Adds a String value for an attribute.
◆ StringAttribute()
| Standard_CString Transfer_Finder::StringAttribute | ( | const Standard_CString | name | ) | const |
Returns a String attribute from its name. "" if not recorded.
◆ ValueType()
|
virtual |
Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.
Reimplemented in TransferBRep_ShapeMapper, TransferBRep_OrientedShapeMapper, and Transfer_TransientMapper.
◆ ValueTypeName()
|
virtual |
Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object.
Reimplemented in TransferBRep_ShapeMapper, TransferBRep_OrientedShapeMapper, and Transfer_TransientMapper.
The documentation for this class was generated from the following file:
