CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdTfSchemaManagerInterface Class Referenceabstract

#include <TfSchemaManagerInterface.h>

Inheritance diagram for OdTfSchemaManagerInterface:
OdRxObject OdTfSchemaManager

Public Member Functions

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
 

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

Represents the interface for the Schema Manager.

Definition at line 51 of file TfSchemaManagerInterface.h.

Constructor & Destructor Documentation

◆ OdTfSchemaManagerInterface()

OdTfSchemaManagerInterface::OdTfSchemaManagerInterface ( )
inline

Creates a new instance of a Schema Manager interface with default parameters.

Definition at line 88 of file TfSchemaManagerInterface.h.

◆ ~OdTfSchemaManagerInterface()

virtual OdTfSchemaManagerInterface::~OdTfSchemaManagerInterface ( )
inlinevirtual

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

Definition at line 93 of file TfSchemaManagerInterface.h.

Member Function Documentation

◆ convertSchema()

virtual void OdTfSchemaManagerInterface::convertSchema ( const OdString & schemeName)
pure virtual

Converts an XML schema to the binary format.

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

Implemented in OdTfSchemaManager.

◆ registerSchema() [1/2]

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

Tries to register the XML or binary schema.

Parameters
schemeName[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.

Implemented in OdTfSchemaManager.

◆ registerSchema() [2/2]

virtual bool OdTfSchemaManagerInterface::registerSchema ( const OdString & schemeName)
pure 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.

Implemented in OdTfSchemaManager.

◆ unloadSchema()

virtual void OdTfSchemaManagerInterface::unloadSchema ( const OdString & schemeName)
pure virtual

Unloads a registered schema.

Parameters
schemeName[in] The schema name.

Implemented in OdTfSchemaManager.


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