a Element 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 Element which acts only as an intermediate. When a Map asks for the HashCode of a Element, this one returns the code it has determined at creation time More...
#include <MoniTool_Element.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< MoniTool_Element > &other) const =0 |
| Specific testof equallity : to be defined by each sub-class, must be False if Elements 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... | |
| const MoniTool_AttrList & | ListAttr () const |
| Returns (readonly) the Attribute List. More... | |
| MoniTool_AttrList & | ChangeAttr () |
| Returns (modifiable) the Attribute List. 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 Element 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 Element which acts only as an intermediate. When a Map asks for the HashCode of a Element, this one returns the code it has determined at creation time
Member Function Documentation
◆ ChangeAttr()
| MoniTool_AttrList& MoniTool_Element::ChangeAttr | ( | ) |
Returns (modifiable) the Attribute List.
◆ Equates()
|
pure virtual |
Specific testof equallity : to be defined by each sub-class, must be False if Elements have not the same true Type, else their contents must be compared.
Implemented in MoniTool_TransientElem.
◆ GetHashCode()
| Standard_Integer MoniTool_Element::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)
◆ ListAttr()
| const MoniTool_AttrList& MoniTool_Element::ListAttr | ( | ) | const |
Returns (readonly) the Attribute List.
◆ SetHashCode()
|
protected |
Stores the HashCode which corresponds to the Value given to create the Mapper.
◆ ValueType()
|
virtual |
Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.
Reimplemented in MoniTool_TransientElem.
◆ 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 MoniTool_TransientElem.
The documentation for this class was generated from the following file:
