CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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
virtual bool registerSchema (const OdString &schemeName)=0
 
virtual bool registerSchema (const OdString &schemaName, OdTf::SaveType fileType)=0
 
virtual void convertSchema (const OdString &schemeName)=0
 
virtual void unloadSchema (const OdString &schemeName)=0
 
 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 ()
 

Detailed Description

This class is designed for working with XML schemes for revision control.

Definition at line 45 of file TfSchemaManager.h.

Constructor & Destructor Documentation

◆ OdTfSchemaManager()

OdTfSchemaManager::OdTfSchemaManager ( )
inline

Definition at line 49 of file TfSchemaManager.h.

◆ ~OdTfSchemaManager()

virtual OdTfSchemaManager::~OdTfSchemaManager ( )
inlinevirtual

Definition at line 50 of file TfSchemaManager.h.

Member Function Documentation

◆ convertSchema()

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

Convert the xml scheme to binary schema.

Parameters
schemeName[in] xml scheme name.
Note
binary scheme will be save in the same folder where situated xml schema, but with file type .tsbf

Implements OdTfSchemaManagerInterface.

◆ getNamesRegisteredSchemes()

void OdTfSchemaManager::getNamesRegisteredSchemes ( OdStringArray setNames)

Get registered scheme names array.

Parameters
setNames[out] array of scheme 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

Try to register the xml scheme or binary schema.

Parameters
schemeName[in] xml/binary schema name. Returns true if the schema is registered. Return false if the schema was registered early.

Implements OdTfSchemaManagerInterface.

◆ registerSchema() [2/2]

bool OdTfSchemaManager::registerSchema ( const OdString schemeName)
virtual

Try to register the xml scheme or binary schema.

Parameters
schemeName[in] xml/binary schema name. Returns true if the schema is registered. Return false if the schema was registered early.
Note
Name of schema must have one of types (.tsbf | .txds)

Implements OdTfSchemaManagerInterface.

◆ setAppServices()

void OdTfSchemaManager::setAppServices ( OdDbHostAppServices pHostAppServices)

Set HostAppServices that will be used bu OdTfSchemaManager.

Parameters
pHostAppServices[in] pointer to OdDbHostAppServices.
Note
setAppServices used in ::odTfInitialize(pHostApp);

◆ unloadSchema()

void OdTfSchemaManager::unloadSchema ( const OdString schemeName)
virtual

Unload registered schema.

Parameters
schemeName[in] scheme name.

Implements OdTfSchemaManagerInterface.

Member Data Documentation

◆ m_appServices

OdDbHostAppServices* OdTfSchemaManager::m_appServices
protected

Definition at line 91 of file TfSchemaManager.h.


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