HIOUtilityDGN Class Reference

#include <HIOUtilityDGN.h>

Public Member Functions

HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
 
HFileInputResult FileInputByKey (const wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
 
HFileInputResult FileInputByKey (const unsigned short *FileName, HC_KEY key, HInputHandlerOptions *options)
 
const char * GetInputName ()
 
HInputHandlerStyle GetInputStyle ()
 
const char * GetInputTypesString ()
 
const char * GetOutputName ()
 
 HIOUtilityDGN ()
 
void InitDGNDirect ()
 
void RegisterInputHandlerTypes ()
 
void ShutdownDGNDirect ()
 
- Public Member Functions inherited from HInputHandler
virtual HFileInputResult FileInputByKey (const __wchar_t *filename, HC_KEY key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const char *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const __wchar_t *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
virtual HFileInputResult FileInputToImageKey (const unsigned short *filename, HC_KEY *image_key, HC_KEY segment_key, HInputHandlerOptions *options)
 
const __wchar_t * GetInputInformation ()
 
unsigned long GetInputOps ()
 
float GetInputPercentProgress ()
 
const __wchar_t * GetInputProgress ()
 
 HInputHandler ()
 
void ReportInputInformation (const char *information)
 This posts information to the information queue.
 
void ReportInputInformation (const __wchar_t *information)
 
void ReportInputPercentProgress (float percent_progress)
 This posts the current percent progress should be between 0.0 and 1.0.
 
void ReportInputProgress (const char *progress)
 This posts the current progress message.
 
void ReportInputProgress (const __wchar_t *progress)
 
HIONoticeCallbackSetInputInformationNoticeCallback (HIONoticeCallback *notice_callback)
 
HIOPercentNoticeCallbackSetInputPercentProgressNoticeCallback (HIOPercentNoticeCallback *percent_notice_callback)
 
HIONoticeCallbackSetInputProgressNoticeCallback (HIONoticeCallback *notice_callback)
 
void SetModuleDirectory (const char *module_directory)
 
void SetModuleDirectory (const __wchar_t *module_directory)
 

Additional Inherited Members

- Protected Member Functions inherited from HInputHandler
void SetFinishedInput ()
 
void SetInputOps (unsigned long ops)
 This sets the HInputOp.
 
void SetStartingInput (const char *filename)
 
void SetStartingInput (const __wchar_t *filename=0)
 
- Protected Attributes inherited from HInputHandler
unsigned long m_InputOps
 This is the HInputOp set for a subclassed instance.
 
__wchar_t * m_module_directory
 

Detailed Description

The HIOUtilityDGN is the integration class for Open Design Alliances (ODA) DGNDirect Toolkit.
Using this integration class allows you to import Microstations's DGN file. This integration is based on DGN Toolkit version 2.xx To use this integration class you will need to obtain a license of DGNDirect Toolkit from ODA.

Constructor & Destructor Documentation

◆ HIOUtilityDGN()

HIOUtilityDGN::HIOUtilityDGN ( )
inline

Constructs an HIOUtilityDGN object.

References HInputOpFileInputByKey, and HInputHandler::SetInputOps().

Member Function Documentation

◆ FileInputByKey() [1/2]

HFileInputResult HIOUtilityDGN::FileInputByKey ( const char *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)
virtual

This method reads the DGN file into the segment tree underneath given key.

Parameters
filenameThe name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for operation.
Returns
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

◆ FileInputByKey() [2/2]

HFileInputResult HIOUtilityDGN::FileInputByKey ( const unsigned short *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
)
virtual

This method reads the DGN file into the segment tree underneath given key.

Parameters
filenameThe UNICODE name of the file to load.
keyThe HOOPS segment key to load model data into.
optionsAn options class containing any needed extra information for operation.
Returns
The #HFileInputResult result of the input operation.

Reimplemented from HInputHandler.

◆ GetInputName()

const char* HIOUtilityDGN::GetInputName ( )
inlinevirtual
Returns
A character pointer denoting the name of the input handler.

Implements HInputHandler.

◆ GetInputStyle()

HInputHandlerStyle HIOUtilityDGN::GetInputStyle ( )
inlinevirtual
Returns
The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

◆ GetInputTypesString()

const char* HIOUtilityDGN::GetInputTypesString ( )
inlinevirtual
Returns
The input extension type that is handled by HIOUtilityDGN which is "dgn".

Implements HInputHandler.

◆ GetOutputName()

const char* HIOUtilityDGN::GetOutputName ( )
inline
Returns
A character pointer denoting the name of the handler.

◆ InitDGNDirect()

void HIOUtilityDGN::InitDGNDirect ( )

This method Initializes Runtime Extension environment and DgnDirect toolkit

◆ RegisterInputHandlerTypes()

void HIOUtilityDGN::RegisterInputHandlerTypes ( )
inlinevirtual

This method registers the "dgn" extension to this handler as an input handler.

Implements HInputHandler.

References HIORegisterInputType.

◆ ShutdownDGNDirect()

void HIOUtilityDGN::ShutdownDGNDirect ( )

This method Uninitializes the DgnDirect toolkit.


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