OdIfcClassesDictionary Class Reference

#include <IfcClassesDictionary.h>

Inheritance diagram for OdIfcClassesDictionary:

Public Member Functions
virtual OdRxObjectPtr	getAt (OdUInt32 id) const
virtual OdRxObjectPtr	putAt (OdUInt32 id, OdRxObject *pObject)
virtual OdRxObjectPtr	remove (OdUInt32 id)
virtual bool	has (OdUInt32 id) const
virtual OdUInt32	numEntries () const
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

A class that provides functionality for working with class dictionaries.

Definition at line 44 of file IfcClassesDictionary.h.

Member Function Documentation

getAt()

virtual OdRxObjectPtr OdIfcClassesDictionary::getAt ( OdUInt32  id ) const

virtual

Retrieves access to an element from the dictionary with the specified position.

Parameters

id	[in] An index value that determines the position in the dictionary.

Returns

Returns a smart pointer to the dictionary element allocated at the specified position.

Remarks

If the specified position is incorrect (for example, when the index value is equal to or greater than the quantity of elements), the method returns a NULL smart pointer (smart pointer object's method isNull() returns true).

has()

virtual bool OdIfcClassesDictionary::has ( OdUInt32  id ) const

virtual

Retrieves whether the dictionary contains an element with the specified position.

Parameters

id	[in] An index value that determines the position in the dictionary.

Returns

Returns true if the dictionary contains an element with the specified position; otherwise, the method returns false.

numEntries()

virtual OdUInt32 OdIfcClassesDictionary::numEntries ( ) const

virtual

Retrieves the quantity of dictionary elements.

Returns

Returns the quantity of dictionary elements.

putAt()

virtual OdRxObjectPtr OdIfcClassesDictionary::putAt ( OdUInt32  id, OdRxObject *  pObject  )

virtual

Sets a new element to the dictionary at the specified position.

Parameters

id	[in] An index value that determines the position in the dictionary.
pObject	[in] A raw pointer to a new element that should be set at the position in the dictionary.

Returns

Returns a smart pointer to the dictionary element allocated at the specified position.

Remarks

If the specified position is incorrect (for example, when the index value is equal to or greater than the quantity of elements), the method returns a NULL smart pointer (smart pointer object's method isNull() returns true).

remove()

virtual OdRxObjectPtr OdIfcClassesDictionary::remove ( OdUInt32  id )

virtual

Removes the element at the specified position from the dictionary.

Parameters

id	[in] An index value that determines the position in the dictionary.

Returns

Returns a smart pointer to the dictionary element removed from the specified position.

Remarks

If the specified position is incorrect (for example, when the index value is equal to or greater than the quantity of elements), the method returns a NULL smart pointer (smart pointer object's method isNull() returns true).

---

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

• IfcClassesDictionary.h