CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
OdRxModelTreeBaseNode Class Reference

#include <RxModelTreeBaseNode.h>

Inheritance diagram for OdRxModelTreeBaseNode:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRxModelTreeBaseNode)
 
 ODRX_HEAP_OPERATORS ()
 
virtual ~OdRxModelTreeBaseNode ()
 
virtual const OdString & getNodeName () const
 
virtual OdUInt64 getUniqueSourceID () const
 
virtual OdUInt64 getUniqueDBID () const
 
virtual HierarchyTreeObjectType getNodeType () const
 
virtual const OdRxModelTreeBaseNodeRawPtrArray & getParents () const
 
virtual const OdRxModelTreeBaseNodePtrArray & getChildren () const
 
virtual const OdArray< PropertyInfo > & getProperties () 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
 

Protected Member Functions

virtual bool addChild (OdRxModelTreeBaseNodePtr &elem)
 
virtual void outFields (OdBaseHierarchyTreeFiler *pFiler) const
 
virtual OdResult inFields (OdBaseHierarchyTreeFiler *pFiler, std::set< OdString > &string_storage)
 
 OdRxModelTreeBaseNode ()
 
 OdRxModelTreeBaseNode (OdRxModelTreeBaseNodeImpl *impl)
 

Protected Attributes

OdRxModelTreeBaseNodeImpl * m_pImpl
 

Friends

class OdRxModelTreeBaseNodeImpl
 
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 node for the Common Data Access API.

<group OdRx_Classes>

Definition at line 143 of file RxModelTreeBaseNode.h.

Constructor & Destructor Documentation

◆ ~OdRxModelTreeBaseNode()

virtual OdRxModelTreeBaseNode::~OdRxModelTreeBaseNode ( )
virtual

Destroys an instance of the OdRxModelTreeBaseNode class.

◆ OdRxModelTreeBaseNode() [1/2]

OdRxModelTreeBaseNode::OdRxModelTreeBaseNode ( )
protected

◆ OdRxModelTreeBaseNode() [2/2]

OdRxModelTreeBaseNode::OdRxModelTreeBaseNode ( OdRxModelTreeBaseNodeImpl *  impl)
protected

Member Function Documentation

◆ addChild()

virtual bool OdRxModelTreeBaseNode::addChild ( OdRxModelTreeBaseNodePtr &  elem)
protectedvirtual

◆ getChildren()

virtual const OdRxModelTreeBaseNodePtrArray & OdRxModelTreeBaseNode::getChildren ( ) const
virtual

Gets child nodes.

Returns
Array of smart pointers to child nodes.

◆ getNodeName()

virtual const OdString & OdRxModelTreeBaseNode::getNodeName ( ) const
virtual

Gets the name of the node object — the element of the hierarchical tree.

Returns
String containing the node name.

◆ getNodeType()

virtual HierarchyTreeObjectType OdRxModelTreeBaseNode::getNodeType ( ) const
virtual

Gets the type of the node — the object of the hierarchical tree.

Returns
Node type.

◆ getParents()

virtual const OdRxModelTreeBaseNodeRawPtrArray & OdRxModelTreeBaseNode::getParents ( ) const
virtual

Gets parent nodes.

Returns
Array of smart pointers to parent nodes.

◆ getProperties()

virtual const OdArray< PropertyInfo > & OdRxModelTreeBaseNode::getProperties ( ) const
virtual

Gets properties info for the node.

Returns
Array of the PropertyInfo objects.

◆ getUniqueDBID()

virtual OdUInt64 OdRxModelTreeBaseNode::getUniqueDBID ( ) const
virtual

Gets the unique identifier of the database.

Returns
Unique identifier represented as an OdUInt64 value.

◆ getUniqueSourceID()

virtual OdUInt64 OdRxModelTreeBaseNode::getUniqueSourceID ( ) const
virtual

Gets the unique identifier of the node — the object of the hierarchical tree.

Returns
Unique identifier represented as an OdUInt64 value.

◆ inFields()

virtual OdResult OdRxModelTreeBaseNode::inFields ( OdBaseHierarchyTreeFiler *  pFiler,
std::set< OdString > &  string_storage 
)
protectedvirtual

◆ ODRX_DECLARE_MEMBERS()

OdRxModelTreeBaseNode::ODRX_DECLARE_MEMBERS ( OdRxModelTreeBaseNode  )

◆ ODRX_HEAP_OPERATORS()

OdRxModelTreeBaseNode::ODRX_HEAP_OPERATORS ( )

◆ outFields()

virtual void OdRxModelTreeBaseNode::outFields ( OdBaseHierarchyTreeFiler *  pFiler) const
protectedvirtual

Friends And Related Function Documentation

◆ OdRxModelHierarchyTreeBaseImpl

friend class OdRxModelHierarchyTreeBaseImpl
friend

Definition at line 217 of file RxModelTreeBaseNode.h.

◆ OdRxModelTreeBaseNodeImpl

friend class OdRxModelTreeBaseNodeImpl
friend

Definition at line 215 of file RxModelTreeBaseNode.h.

Member Data Documentation

◆ m_pImpl

OdRxModelTreeBaseNodeImpl* OdRxModelTreeBaseNode::m_pImpl
protected

Definition at line 216 of file RxModelTreeBaseNode.h.


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