MoniTool_TransientElem Class Reference

an TransientElem defines an Element for a specific input class its definition includes the value of the Key to be mapped, and the HashCoder associated to the class of the Key More...

#include <MoniTool_TransientElem.hxx>

Inheritance diagram for MoniTool_TransientElem:

Public Member Functions
	MoniTool_TransientElem (const Handle< Standard_Transient > &akey)
	Creates a TransientElem with a Value. This Value can then not be changed. It is used by the Hasher to compute the HashCode, which will then be stored for an immediate reading.
const Handle< Standard_Transient > &	Value () const
	Returns the contained value.
Standard_Boolean	Equates (const Handle< MoniTool_Element > &other) const override
	Specific testof equality : defined as False if <other> has not the same true Type, else contents are compared (by C++ operator ==)
virtual Handle< Standard_Type >	ValueType () const override
	Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.
virtual Standard_CString	ValueTypeName () const override
	Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object.
Public Member Functions inherited from MoniTool_Element
	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)
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.

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.
Protected Member Functions inherited from MoniTool_Element
void	SetHashCode (const size_t code)
	Stores the HashCode which corresponds to the Value given to create the Mapper.

Detailed Description

an TransientElem defines an Element for a specific input class its definition includes the value of the Key to be mapped, and the HashCoder associated to the class of the Key

Transient from Standard defines the class to be keyed MapTransientHasher from TColStd is the associated Hasher DataInfo from MoniTool is an additional class which helps to provide information on the value (template : see DataInfo)

Constructor & Destructor Documentation

MoniTool_TransientElem()

MoniTool_TransientElem::MoniTool_TransientElem

(

const Handle< Standard_Transient > &

akey

)

Creates a TransientElem with a Value. This Value can then not be changed. It is used by the Hasher to compute the HashCode, which will then be stored for an immediate reading.

Member Function Documentation

Equates()

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

overridevirtual

Specific testof equality : defined as False if <other> has not the same true Type, else contents are compared (by C++ operator ==)

Implements MoniTool_Element.

Value()

const Handle< Standard_Transient > & MoniTool_TransientElem::Value

(

)

const

Returns the contained value.

ValueType()

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

overridevirtual

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

Reimplemented from MoniTool_Element.

ValueTypeName()

virtual Standard_CString MoniTool_TransientElem::ValueTypeName ( ) const

overridevirtual

Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object.

Reimplemented from MoniTool_Element.

---

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

• MoniTool_TransientElem.hxx