OdRxModelHierarchyTreeBase Class Reference

#include <RxModelHierarchyTreeBase.h>

Inheritance diagram for OdRxModelHierarchyTreeBase:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdRxModelHierarchyTreeBase)
	ODRX_HEAP_OPERATORS ()
virtual	~OdRxModelHierarchyTreeBase ()
virtual OdRxModelTreeBaseNodePtr	createDatabaseHierarchyTree (const OdRxObject *pDb, const bool create_properties_cache=true, const bool class_dependent_hierarchy=false, const bool class_dependent_property=false)
virtual OdRxModelTreeBaseNodePtr	createDatabaseHierarchyTree (const OdRxObject *pDb, const std::set< OdString > *collected_properties, const bool class_dependent_hierarchy=false, const bool class_dependent_property=false)
virtual OdRxModelTreeBaseNodePtr	getDatabaseNode () const
virtual const OdArray< PropertyInfo > &	getNodeProperties (OdUInt64 unique_DB_ID, OdUInt64 unique_source_ID)
void	serialize (OdBaseHierarchyTreeFiler *pFiler) const
OdResult	deserialize (OdBaseHierarchyTreeFiler *pFiler)
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
	OdRxModelHierarchyTreeBase ()
	OdRxModelHierarchyTreeBase (OdRxModelHierarchyTreeBaseImpl *impl)

Protected Attributes
OdRxModelHierarchyTreeBaseImpl *	m_pImpl

Friends
class	OdRxModelHierarchyTreeBaseImpl

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

Detailed Description

This class is a base class that implements a database hierarchical tree for the Common Data Access API.

<group OdRx_Classes>

Definition at line 54 of file RxModelHierarchyTreeBase.h.

Constructor & Destructor Documentation

~OdRxModelHierarchyTreeBase()

virtual OdRxModelHierarchyTreeBase::~OdRxModelHierarchyTreeBase ( )

virtual

Destroys an instance of the OdRxModelHierarchyTreeBase class.

OdRxModelHierarchyTreeBase() [1/2]

OdRxModelHierarchyTreeBase::OdRxModelHierarchyTreeBase ( )

protected

OdRxModelHierarchyTreeBase() [2/2]

OdRxModelHierarchyTreeBase::OdRxModelHierarchyTreeBase ( OdRxModelHierarchyTreeBaseImpl *  impl )

protected

Member Function Documentation

createDatabaseHierarchyTree() [1/2]

virtual OdRxModelTreeBaseNodePtr OdRxModelHierarchyTreeBase::createDatabaseHierarchyTree ( const OdRxObject *  pDb, const bool  create_properties_cache = true, const bool  class_dependent_hierarchy = false, const bool  class_dependent_property = false  )

virtual

Creates a hierarchical tree for the database.

Parameters

pDb	[in] Pointer to the source database object.
create_properties_cache	[in] Flag to create cache of properties. The default value is true.
class_dependent_hierarchy	[in] Flag to optimize the creation of a hierarchical tree. It can only be set to true if the properties of database objects with a hierarchical attribute are statically dependent on the object type. The default value is false.
class_dependent_property	[in] Flag to optimize cache creation. It can be set to true only if all properties of database objects are statically dependent on the object type. The default value is false.

Returns

Smart pointer to the root node of the hierarchical tree.

createDatabaseHierarchyTree() [2/2]

virtual OdRxModelTreeBaseNodePtr OdRxModelHierarchyTreeBase::createDatabaseHierarchyTree ( const OdRxObject *  pDb, const std::set< OdString > *  collected_properties, const bool  class_dependent_hierarchy = false, const bool  class_dependent_property = false  )

virtual

Creates a hierarchical tree for the database.

Parameters

pDb	[in] Pointer to the source database object.
collected_properties	[in] Pointer to a set of property names that will be added to the cache. If NULL, all properties will be cached.
class_dependent_hierarchy	[in] Flag to optimize the creation of a hierarchical tree. It can only be set to true if the properties of database objects with a hierarchical attribute are statically dependent on the object type. The default value is false.
class_dependent_property	[in] Flag to optimize cache creation. It can be set to true only if all properties of database objects are statically dependent on the object type. The default value is false.

Returns

Smart pointer to the root node of the hierarchical tree.

deserialize()

OdResult OdRxModelHierarchyTreeBase::deserialize

(

OdBaseHierarchyTreeFiler *

pFiler

)

Deserializes the hierarchical tree.

Parameters

pDb	[in] Pointer to a filer object.

Returns

Result of the deserialization operation.

getDatabaseNode()

virtual OdRxModelTreeBaseNodePtr OdRxModelHierarchyTreeBase::getDatabaseNode ( ) const

virtual

Gets the root node of the hierarchical tree.

Returns

Smart pointer to the root node of the tree.

getNodeProperties()

virtual const OdArray< PropertyInfo > & OdRxModelHierarchyTreeBase::getNodeProperties ( OdUInt64  unique_DB_ID, OdUInt64  unique_source_ID  )

virtual

Gets the properties for a node by unique identifier.

Parameters

unique_DB_ID	[in] Unique database identifier represented as an OdUInt64 value.
unique_source_ID	[in] Unique identifier represented as an OdUInt64 value.

Returns

Array of the PropertyInfo objects.

ODRX_DECLARE_MEMBERS()

OdRxModelHierarchyTreeBase::ODRX_DECLARE_MEMBERS

(

OdRxModelHierarchyTreeBase

)

ODRX_HEAP_OPERATORS()

OdRxModelHierarchyTreeBase::ODRX_HEAP_OPERATORS

(

)

serialize()

void OdRxModelHierarchyTreeBase::serialize

(

OdBaseHierarchyTreeFiler *

pFiler

)

const

Serializes the hierarchical tree.

Parameters

pDb	[in] Pointer to a filer object.

Friends And Related Function Documentation

OdRxModelHierarchyTreeBaseImpl

friend class OdRxModelHierarchyTreeBaseImpl

friend

Definition at line 137 of file RxModelHierarchyTreeBase.h.

Member Data Documentation

m_pImpl

OdRxModelHierarchyTreeBaseImpl* OdRxModelHierarchyTreeBase::m_pImpl

protected

Definition at line 138 of file RxModelHierarchyTreeBase.h.

---

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

• RxModelHierarchyTreeBase.h