CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdTfPropertiesContainer Class Referenceabstract

#include <TfObject.h>

Inheritance diagram for OdTfPropertiesContainer:
OdRxObject

Public Types

typedef OdInt32 size_type
 

Public Member Functions

virtual OdTfClass * owner () const =0
 
virtual size_type size () const =0
 
virtual bool contains (const OdTfProperty *pProp) const =0
 
virtual const OdTfProperty * find (size_type index) const =0
 
virtual const OdTfProperty * find (const OdString &name) const =0
 
virtual const OdTfProperty * find (const OdString &name, const OdTfVariant::Type type) const =0
 
virtual size_type index (const OdTfProperty *pProp) const =0
 
virtual bool unique (const OdString &name) const =0
 
virtual bool unique (const OdString &name, const OdTfVariant::Type type) const =0
 
virtual OdRxIteratorPtr iterator () const =0
 
- 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

An abstract interface class that implements storage for a set of properties and provides additional functionality: Searching for a property by its index or name Checking property uniqueness Sequential access to properties using an iterator object <group OdTf_Classes>

Definition at line 159 of file TfObject.h.

Member Typedef Documentation

◆ size_type

typedef OdInt32 OdTfPropertiesContainer::size_type

A data type that represents a size of properties in bytes. <group OdTf_Types>

Definition at line 169 of file TfObject.h.

Member Function Documentation

◆ contains()

virtual bool OdTfPropertiesContainer::contains ( const OdTfProperty *  pProp) const
pure virtual

Retrieves whether the container contains a specified property.

Parameters
pProp[in] A pointer to a property object to search for.
Returns
Returns true if the specified property is found in the container; otherwise returns false.

◆ find() [1/3]

virtual const OdTfProperty * OdTfPropertiesContainer::find ( const OdString &  name) const
pure virtual

Searches for a property in the container by its name.

Parameters
name[in] A name of the property to be found.
Returns
Returns a pointer to a property object if it was found; otherwise returns a NULL pointer.
Remarks
If the container contains more than one property with the specified name, the first found property is returned.

◆ find() [2/3]

virtual const OdTfProperty * OdTfPropertiesContainer::find ( const OdString &  name,
const OdTfVariant::Type  type 
) const
pure virtual

Searches for a property in the container by its name and data type.

Parameters
name[in] A name of the property to be found.
type[in] A data type of the property to be found.
Returns
Returns a pointer to a property object if it was found; otherwise returns a NULL pointer.
Remarks
A property in the container matches the search condition only if the name and data type match the search parameters.
If the container contains more than one property with the specified name and type, the first found property is returned.

◆ find() [3/3]

virtual const OdTfProperty * OdTfPropertiesContainer::find ( size_type  index) const
pure virtual

Searches for a property in the container by its index, which specifies the property's position in the container.

Parameters
index[in] An index of the property to be found.
Returns
Returns a pointer to a property object if it was found; otherwise returns a NULL pointer.

◆ index()

virtual size_type OdTfPropertiesContainer::index ( const OdTfProperty *  pProp) const
pure virtual

Retrieves the index value for a specified property. The index value determines the position of the property in the container.

Parameters
pProp[in] A pointer to a property object.
Returns
Returns an index value if the specified property is found in the container; otherwise returns -1.

◆ iterator()

virtual OdRxIteratorPtr OdTfPropertiesContainer::iterator ( ) const
pure virtual

Retrieves the properties container iterator object that provides sequential access to properties in the container.

Returns
Returns a smart pointer to an iterator object represented as the OdRxIterator class instance.

◆ owner()

virtual OdTfClass * OdTfPropertiesContainer::owner ( ) const
pure virtual

Retrieves the object that is the owner of the properties container.

Returns
Returns a pointer to the owner object represented as an instance of the OdTfClass class.

◆ size()

virtual size_type OdTfPropertiesContainer::size ( ) const
pure virtual

Retrieves the size of the properties container.

Returns
Returns the quantity of bytes that are allocated by the properties container in the memory.

◆ unique() [1/2]

virtual bool OdTfPropertiesContainer::unique ( const OdString &  name) const
pure virtual

Retrieves the uniqueness flag value for a property specified with its name. The uniqueness flag value is equal to true if the property object is unique in the container; otherwise the flag value is equal to false.

Parameters
pProp[in] A property object's name.
Returns
Returns true if the property object is found in the container and is unique; otherwise returns false.

◆ unique() [2/2]

virtual bool OdTfPropertiesContainer::unique ( const OdString &  name,
const OdTfVariant::Type  type 
) const
pure virtual

Retrieves the uniqueness flag value for a property specified with its name and data type. The uniqueness flag value is equal to true if the property object is unique in the container; otherwise the flag value is equal to false.

Parameters
pProp[in] A property object's name.
type[in] A property object's data type.
Returns
Returns true if the property object is found in the container and is unique; otherwise returns false.
Remarks
A property in the container matches the search condition only if the name and data type match the search parameters.
The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:33