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>

Inheritance diagram for MoniTool_Element:

[legend]

Public Member Functions
	MoniTool_Element ()
	Empty constructor.

size_t	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)

virtual Standard_Boolean	Equates (const Handle< MoniTool_Element > &other) const =0
	Specific testof equality : to be defined by each sub-class, must be False if Elements have not the same true Type, else their contents must be compared.

virtual Handle< Standard_Type >	ValueType () const
	Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.

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.

const MoniTool_AttrList &	ListAttr () const
	Returns (readonly) the Attribute List.

MoniTool_AttrList &	ChangeAttr ()
	Returns (modifiable) the Attribute List.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

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.

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.

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.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Protected Member Functions
void	SetHashCode (const size_t code)
	Stores the HashCode which corresponds to the Value given to create the Mapper.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

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

Constructor & Destructor Documentation

◆ MoniTool_Element()

MoniTool_Element::MoniTool_Element ( )

Empty constructor.

Member Function Documentation

◆ ChangeAttr()

MoniTool_AttrList & MoniTool_Element::ChangeAttr ( )

Returns (modifiable) the Attribute List.

◆ Equates()

virtual Standard_Boolean MoniTool_Element::Equates ( const Handle< MoniTool_Element > & other ) const

pure virtual

Specific testof equality : 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()

size_t 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()

void MoniTool_Element::SetHashCode ( const size_t code )

protected

Stores the HashCode which corresponds to the Value given to create the Mapper.

◆ ValueType()

virtual Handle< Standard_Type > MoniTool_Element::ValueType ( ) const

virtual

Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.

Reimplemented in MoniTool_TransientElem.

◆ ValueTypeName()

virtual Standard_CString MoniTool_Element::ValueTypeName ( ) const