CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdTfSchemaManager Class Reference

#include <TfSchemaManager.h>

Inheritance diagram for OdTfSchemaManager:
OdTfSchemaManagerInterface OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdTfSchemaManager)
 
 OdTfSchemaManager ()
 
virtual ~OdTfSchemaManager ()
 
bool registerSchema (const OdString &schemeName)
 
virtual bool registerSchema (const OdString &schemaName, OdTf::SaveType fileType)
 
virtual void convertSchema (const OdString &schemeName)
 
void setAppServices (OdDbHostAppServices *pHostAppServices)
 
void unloadSchema (const OdString &schemeName)
 
void getNamesRegisteredSchemes (OdStringArray &setNames)
 
- Public Member Functions inherited from OdTfSchemaManagerInterface
 OdTfSchemaManagerInterface ()
 
virtual ~OdTfSchemaManagerInterface ()
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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

void mergeSchema (const OdString &schemeName)
 
void mergeSchemaBin (const OdString &schemeName)
 

Protected Attributes

OdDbHostAppServicesm_appServices
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 

Detailed Description

This class represents working with XML schemas for revision control.

Definition at line 45 of file TfSchemaManager.h.

Constructor & Destructor Documentation

◆ OdTfSchemaManager()

OdTfSchemaManager::OdTfSchemaManager ( )
inline

Definition at line 50 of file TfSchemaManager.h.

◆ ~OdTfSchemaManager()

virtual OdTfSchemaManager::~OdTfSchemaManager ( )
inlinevirtual

Destructor for objects of the OdTfSchemaManager class. Frees allocated resources.

Definition at line 56 of file TfSchemaManager.h.

Member Function Documentation

◆ convertSchema()

virtual void OdTfSchemaManager::convertSchema ( const OdString & schemeName)
virtual

Converts an XML schema to a binary schema.

Parameters
schemeName[in] The XML schema name.
Remarks
The binary schema is saved in the same folder as the XML one, but with the file type .tsbf.

Implements OdTfSchemaManagerInterface.

◆ getNamesRegisteredSchemes()

void OdTfSchemaManager::getNamesRegisteredSchemes ( OdStringArray & setNames)

Gets an array of registered schema names.

Parameters
setNames[out] Array of schema names.

◆ mergeSchema()

void OdTfSchemaManager::mergeSchema ( const OdString & schemeName)
protected

◆ mergeSchemaBin()

void OdTfSchemaManager::mergeSchemaBin ( const OdString & schemeName)
protected

◆ ODRX_DECLARE_MEMBERS()

OdTfSchemaManager::ODRX_DECLARE_MEMBERS ( OdTfSchemaManager )

◆ registerSchema() [1/2]

virtual bool OdTfSchemaManager::registerSchema ( const OdString & schemaName,
OdTf::SaveType fileType )
virtual

Tries to register the XML or binary schema.

Parameters
schemaName[in] The XML or binary schema name.
fileType[in] Type of the file. Refer to the OdTf::SaveType enumerated type for the available file types.
Returns
The true value if the schema is registered, or false if the schema was registered earlier.

Implements OdTfSchemaManagerInterface.

◆ registerSchema() [2/2]

bool OdTfSchemaManager::registerSchema ( const OdString & schemeName)
virtual

Tries to register the XML or binary schema.

Parameters
schemeName[in] The XML or binary schema name.
Returns
The true value if the schema is registered, or false if the schema was registered earlier.
Remarks
The name of the schema must have a type .tsbf or .txds.

Implements OdTfSchemaManagerInterface.

◆ setAppServices()

void OdTfSchemaManager::setAppServices ( OdDbHostAppServices * pHostAppServices)

Sets HostAppServices to be used by OdTfSchemaManager.

Parameters
pHostAppServices[in] Pointer to OdDbHostAppServices.
Remarks
The method setAppServices() is used in ::odTfInitialize(pHostApp);.

◆ unloadSchema()

void OdTfSchemaManager::unloadSchema ( const OdString & schemeName)
virtual

Unloads a registered schema.

Parameters
schemeName[in] Schema name.

Implements OdTfSchemaManagerInterface.

Member Data Documentation

◆ m_appServices

OdDbHostAppServices* OdTfSchemaManager::m_appServices
protected

Definition at line 101 of file TfSchemaManager.h.


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