DATAKIT API  V2025.3
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
WriteOptions Class Reference

This class provides several options to tunes cgr Writter.
It must be provided to cgr::cgrw_InitWrite method. More...

Public Member Functions

Dtk_UInt32 GetFileRelease () const
 Retrieve the Written file release. More...
 
void SetFileRelease (const Dtk_UInt32 inRelease)
 Sets the release for the written files. More...
 
 WriteOptions ()
 Base constructor. More...
 
 ~WriteOptions ()
 Destructor. More...
 

Protected Attributes

Dtk_UChar8 _FileRelease
 

Detailed Description

This class provides several options to tunes cgr Writter.
It must be provided to cgr::cgrw_InitWrite method.

//...

Constructor & Destructor Documentation

◆ WriteOptions()

WriteOptions::WriteOptions ( )

Base constructor.

82 :_FileRelease(14) {}

◆ ~WriteOptions()

WriteOptions::~WriteOptions ( )

Destructor.

85 {}

Member Function Documentation

◆ GetFileRelease()

Dtk_UInt32 WriteOptions::GetFileRelease ( ) const

Retrieve the Written file release.

102 { return _FileRelease; }

◆ SetFileRelease()

void WriteOptions::SetFileRelease ( const Dtk_UInt32  inRelease)

Sets the release for the written files.

the valid versions are 14 and 19.

Parameters
[in]inRelease: The file release.
91  {
92  switch (inRelease)
93  {
94  case 19:
95  _FileRelease = (Dtk_UChar8)inRelease; return;
96  case 14:
97  default:
98  _FileRelease = 14; return;
99  }
100  }

Field Documentation

◆ _FileRelease

Dtk_UChar8 WriteOptions::_FileRelease
protected
WriteOptions::_FileRelease
Dtk_UChar8 _FileRelease
Definition: cgrw.hpp:79
Dtk_UChar8
unsigned char Dtk_UChar8
Definition: define.h:698