OdRxDynamicCollectionAttribute Class Reference

#include <RxAttribute.h>

Inheritance diagram for OdRxDynamicCollectionAttribute:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxDynamicCollectionAttribute)
int	count () const
const OdRxDynamicAttribute *	getAt (int index) const
OdRxDynamicAttribute *	getAt (int index)
const OdRxDynamicAttribute *	getByName (const OdString name, bool caseSensitive) const
OdRxDynamicAttribute *	getByName (const OdString name, bool caseSensitive)
OdResult	add (const OdRxDynamicAttribute *attribute)
OdResult	remove (const OdRxDynamicAttribute *attribute)
Public Member Functions inherited from OdRxAttribute
	ODRX_DECLARE_MEMBERS (OdRxAttribute)
virtual	~OdRxAttribute ()
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

Protected Member Functions
	OdRxDynamicCollectionAttribute (OdRxDynamicCollectionAttributeImpl *)
Protected Member Functions inherited from OdRxAttribute
	OdRxAttribute (OdRxAttributeImpl *)

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

Detailed Description

<group OdRx_Classes>

Container for the dynamic attributes.

Definition at line 1044 of file RxAttribute.h.

Constructor & Destructor Documentation

OdRxDynamicCollectionAttribute()

OdRxDynamicCollectionAttribute::OdRxDynamicCollectionAttribute ( OdRxDynamicCollectionAttributeImpl *  )

protected

Member Function Documentation

add()

OdResult OdRxDynamicCollectionAttribute::add

(

const OdRxDynamicAttribute *

attribute

)

Adds an attribute to the collection.

Parameters

attribute

[in] Attribute to be added to the collection.

Returns

eOk if an attribute is added to the collection successfully, eInvalidInput if the attribute parameter is invalid.

count()

int OdRxDynamicCollectionAttribute::count

(

)

const

Constructor. Creates an attribute of the OdRxDynamicCollectionAttribute type.

Returns

Smart pointer to a constructed attribute object.

Gets the number of elements in the collection.

Returns

Number of elements in the collection.

getAt() [1/2]

OdRxDynamicAttribute * OdRxDynamicCollectionAttribute::getAt

(

int

index

)

Retrieves the attribute at the specified index (non-constant version).

Parameters

index

[in] Index of the attribute to be retrieved.

Returns

Pointer to the attribute at the given index.

getAt() [2/2]

const OdRxDynamicAttribute * OdRxDynamicCollectionAttribute::getAt

(

int

index

)

const

Retrieves the attribute at the specified index (constant version).

Parameters

index

[in] Index of the attribute to be retrieved.

Returns

Pointer to the attribute at the given index.

getByName() [1/2]

OdRxDynamicAttribute * OdRxDynamicCollectionAttribute::getByName	(	const OdString	name,
		bool	caseSensitive
	)

Retrieves the attribute by its name (non-constant version).

Parameters

name	[in] Name of the attribute to be retrieved.
caseSensitive	[in] Case sensitive string comparison flag.

Returns

Pointer to the attribute at the given index.

getByName() [2/2]

const OdRxDynamicAttribute * OdRxDynamicCollectionAttribute::getByName	(	const OdString	name,
		bool	caseSensitive
	)		const

Retrieves the attribute by its name.

Parameters

name	[in] Name of the attribute to be retrieved.
caseSensitive	[in] Case sensitive string comparison flag.

Returns

Pointer to the attribute at the given index.

ODRX_DECLARE_MEMBERS()

OdRxDynamicCollectionAttribute::ODRX_DECLARE_MEMBERS

(

OdRxDynamicCollectionAttribute

)

remove()

OdResult OdRxDynamicCollectionAttribute::remove

(

const OdRxDynamicAttribute *

attribute

)

Removes the attribute from the collection.

Parameters

attribute

[in] Attribute to be removed from the collection.

Returns

eOk if the attribute is removed from the collection successfully, or eKeyNotFound otherwise.

---

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

• RxAttribute.h