HIOUtilitySpheres Class Reference

#include <HIOUtilitySpheres.h>

Inheritance diagram for HIOUtilitySpheres:

HInputHandler HOutputHandler

List of all members.

Public Member Functions

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


Detailed Description

The HIOUtilitySpheres class is used for reading and writing Sphere Files (.sph)

Constructor & Destructor Documentation

HIOUtilitySpheres::HIOUtilitySpheres (  )  [inline]

virtual HIOUtilitySpheres::~HIOUtilitySpheres (  )  [inline, virtual]


Member Function Documentation

void HIOUtilitySpheres::RegisterInputHandlerTypes (  )  [inline, virtual]

Implements HInputHandler.

References HIORegisterInputType.

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

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

Implements HOutputHandler.

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

Implements HInputHandler.

const char* HIOUtilitySpheres::GetInputTypesString (  )  [inline, virtual]

Implements HInputHandler.

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

Implements HInputHandler.

References HInputHandlerStyleModel.

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

This method reads an .sph file into the segment referenced by 'key'.

Reimplemented from HInputHandler.

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

Reimplemented from HInputHandler.

void HIOUtilitySpheres::RegisterOutputHandlerTypes (  )  [inline, virtual]

Implements HOutputHandler.

References HIORegisterOutputType.

const char* HIOUtilitySpheres::GetOutputTypesString (  )  [inline, virtual]

Implements HOutputHandler.

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

Implements HOutputHandler.

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

This method creates an .sph file of the segment tree defined under the segment referened by 'key'.

Reimplemented from HOutputHandler.

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

Reimplemented from HOutputHandler.


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