HIOUtilityCGM

Functions

HIOUtilityCGM

~HIOUtilityCGM

const char *

GetOutputName

void

RegisterOutputHandlerTypes

const char *

GetOutputTypesString

HOutputHandlerStyle

GetOutputStyle

const char *

GetOutputDefaultHSRA

HFileIOResult

FileOutputByKey

HFileIOResult

FileOutputByKey

HFileIOResult

FileOutputByKey

Detailed Description

class HIOUtilityCGM : public HOutputHandler

The HIOUtilityCGM is the class for writing CGM files using the HOOPS CGM driver.

Public Functions

inline HIOUtilityCGM()

Constructs an HIOUtilityCGM object.

inline ~HIOUtilityCGM()
inline virtual const char *GetOutputName()
Returns

A character pointer denoting the name of the handler.

inline virtual void RegisterOutputHandlerTypes()

This method registers the “cgm” extension to this handler as an output handler.

inline virtual const char *GetOutputTypesString()
Returns

The string of the type of output this handler creates which is “cgm”.

inline virtual HOutputHandlerStyle GetOutputStyle()
Returns

The type of output style which is HOutputHandlerStyleHardcopy.

inline virtual const char *GetOutputDefaultHSRA()
Returns

The default HSRA for the HIOUtilityCGM instance.

virtual HFileIOResult FileOutputByKey(const __wchar_t *filename, HC_KEY key, HOutputHandlerOptions *options)

This method writes a CGM file out of the segment tree underneath the given key.

Parameters
  • filename – The name of the file to output.

  • key – The HOOPS segment key to get output data from.

  • options – The options class containing any needed extra information for the operation.

Returns

The #HFileOutputResult result of the output operation.

inline virtual HFileIOResult FileOutputByKey(const unsigned short *filename, HC_KEY key, HOutputHandlerOptions *options)

This method writes model data from a given HOOPS key to a given output file. Note that this must be implemented 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.

inline virtual HFileIOResult FileOutputByKey(const char *filename, HC_KEY key, HOutputHandlerOptions *options)

This method writes model data from a given HOOPS key to a given output file. Note that this must be implemented 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.