Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

HIOUtilityHsf Class Reference

#include <HIOUtilityHsf.h>

Inheritance diagram for HIOUtilityHsf:

HInputHandler HOutputHandler

List of all members.

Public Member Functions

HFileInputResult FileInputByKey (const unsigned short *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const char *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileInputResult FileInputByKey (const __wchar_t *FileName, HC_KEY key, HInputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const char *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)
HFileOutputResult FileOutputByKey (const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)
const char * GetInputName ()
HInputHandlerStyle GetInputStyle ()
const char * GetInputTypesString ()
const char * GetOutputName ()
HOutputHandlerStyle GetOutputStyle ()
const char * GetOutputTypesString ()
 HIOUtilityHsf ()
void RegisterInputHandlerTypes ()
void RegisterOutputHandlerTypes ()


Detailed Description

The HIOUtilityHsf used for reading and writing HOOPS Stream Files (HSFs) in a non-streaming way.

Constructor & Destructor Documentation

HIOUtilityHsf::HIOUtilityHsf (  )  [inline]


Member Function Documentation

HFileInputResult HIOUtilityHsf::FileInputByKey ( const unsigned short *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

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

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

HFileInputResult HIOUtilityHsf::FileInputByKey ( const char *  filename,
HC_KEY  key,
HInputHandlerOptions options 
) [inline, virtual]

This method loads model data from a given file to a given HOOPS segment key. Note that this must be implemented in a subclassed HInputHandler instance handling models.

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

Reimplemented from HInputHandler.

References HInputHandler::FileInputByKey().

HFileInputResult HIOUtilityHsf::FileInputByKey ( const __wchar_t *  FileName,
HC_KEY  key,
HInputHandlerOptions options 
) [virtual]

This method reads a HSF file into the segment defined by key. To facilitate streaming most applications implement their own HSF import on the application side. This is here for completeness and currently creates it's own stream toolkit object.

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

Reimplemented from HInputHandler.

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const char *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options The options class containing any needed extra information for the operation.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const unsigned short *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [inline, virtual]

This method writes model data from a given HOOPS key to a given output file. Note that this must be implimented in a subclassed HOutputHandler instance handling models.

Parameters:
filename The wide character name of the file to output.
key The HOOPS segment key to get output model data from.
options The options class containing any needed extra information for the operation.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

References HOutputHandler::FileOutputByKey().

HFileOutputResult HIOUtilityHsf::FileOutputByKey ( const __wchar_t *  filename,
HC_KEY  key,
HOutputHandlerOptions options 
) [virtual]

This method creates a HSF file of the segment tree defined under key. The StreamToolkit object associated with the HBaseView object, which is passed in via the options structure is used to create the HSF.

Parameters:
filename The name of the file to output.
key The HOOPS segment key to output model data from.
options The options class containing a pointer the HStreamFileToolkit object in m_pExtendedData.
Returns:
The HFileOutputResult result of the output operation.

Reimplemented from HOutputHandler.

const char* HIOUtilityHsf::GetInputName (  )  [inline, virtual]

Returns:
A character pointer denoting the name of the input handler.

Implements HInputHandler.

HInputHandlerStyle HIOUtilityHsf::GetInputStyle (  )  [inline, virtual]

Returns:
The type of input style which is HInputHandlerStyleModel.

Implements HInputHandler.

References HInputHandlerStyleModel.

const char* HIOUtilityHsf::GetInputTypesString (  )  [virtual]

Returns:
The input extension type that is handled by HIOUtilityHsf.

Implements HInputHandler.

const char* HIOUtilityHsf::GetOutputName (  )  [inline, virtual]

Returns:
A character pointer denoting the name of the handler.

Implements HOutputHandler.

HOutputHandlerStyle HIOUtilityHsf::GetOutputStyle (  )  [inline, virtual]

Returns:
The type of output style which is HOutputHandlerStyleModel.

Implements HOutputHandler.

const char* HIOUtilityHsf::GetOutputTypesString (  )  [virtual]

Returns:
The string of the type of output this handler creates.

Implements HOutputHandler.

void HIOUtilityHsf::RegisterInputHandlerTypes (  )  [virtual]

This method registers the "hsf" extensions to this handler as an input handler.

Implements HInputHandler.

void HIOUtilityHsf::RegisterOutputHandlerTypes (  )  [virtual]

This method registers the "hsf" extensions to this handler as an output handler.

Implements HOutputHandler.


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