This class provides several options to tunes CatiaV5 Writter.
It must be provided to catiav5w::InitWrite method. More...

Public Member Functions
Dtk_bool	AreReferencePlanesWrittenAsHidden () const
	Tells if the reference planes are written as hidden. More...

Dtk_UInt32	GetFileRelease () const
	Retrieve the Written file release. More...

Dtk_ErrorStatus	SetFileRelease (const Dtk_UInt32 inRelease)
	Sets the release for the written files. More...

	WriteOptions ()
	Default constructor. More...

void	WriteReferencePlaneAsHidden ()
	Sets the reference plane writting as hidden. More...

void	WriteReferencePlaneAsVisible ()
	Sets the reference plane writting as visible. More...

	~WriteOptions ()
	Destructor. More...

Static Public Member Functions
static Dtk_UInt32	GetMaximumFileReleaseHandled ()
	Return the maximum file release number handled by the writer. More...

Protected Attributes
Dtk_UChar8	_FileRelease

Dtk_bool	_WriteReferencePlanesAsHidden
	Option to write reference planes as hidden or visible - visible by default -. More...

Detailed Description

This class provides several options to tunes CatiaV5 Writter.
It must be provided to catiav5w::InitWrite method.

//...
Dtk_string LogFile = L"MyLogFile.log";
catiav5w::WriteOptions V5Options;
V5Options.WriteReferencePlaneAsHidden();
Dtk_ErrorStatus err = catiav5w::InitWrite( LogFile, NULL, V5Options);
//...

Constructor & Destructor Documentation

◆ WriteOptions()

catiav5w::WriteOptions::WriteOptions ( )

Default constructor.

                          : _WriteReferencePlanesAsHidden( 0 ), _FileRelease( 14 )
           {
           }

◆ ~WriteOptions()

catiav5w::WriteOptions::~WriteOptions ( )

Destructor.

57 {

58 }

Member Function Documentation

◆ AreReferencePlanesWrittenAsHidden()

Dtk_bool catiav5w::WriteOptions::AreReferencePlanesWrittenAsHidden ( ) const

Tells if the reference planes are written as hidden.

Returns: DTK_TRUE if the reference planes are written as hidden DTK_FALSE else.

           {
                return _WriteReferencePlanesAsHidden;
           }

◆ GetFileRelease()

Dtk_UInt32 catiav5w::WriteOptions::GetFileRelease ( ) const

Retrieve the Written file release.

           {
                return _FileRelease;
           }

◆ GetMaximumFileReleaseHandled()

static Dtk_UInt32 catiav5w::WriteOptions::GetMaximumFileReleaseHandled ( )

static

Return the maximum file release number handled by the writer.

◆ SetFileRelease()

Dtk_ErrorStatus catiav5w::WriteOptions::SetFileRelease ( const Dtk_UInt32 inRelease )

Sets the release for the written files.

The valid versions are 14 and from 19 to GetMaximumFileReleaseHandled(). You can have more information from the API documentation.

Parameters

[in] inRelease : The file release.

Returns: dtkNoError if success.; dtkErrorVersionNotSupported if fails. In this case, the 14 release number will be be used.

◆ WriteReferencePlaneAsHidden()

void catiav5w::WriteOptions::WriteReferencePlaneAsHidden ( )

Sets the reference plane writting as hidden.

See also: WriteReferencePlaneAsVisible()

           {
                _WriteReferencePlanesAsHidden = DTK_TRUE;
           }

◆ WriteReferencePlaneAsVisible()

void catiav5w::WriteOptions::WriteReferencePlaneAsVisible ( )

Sets the reference plane writting as visible.

See also: WriteReferencePlaneAsHidden()

           {
                _WriteReferencePlanesAsHidden = DTK_FALSE;
           }

Field Documentation

◆ _FileRelease

Dtk_UChar8 catiav5w::WriteOptions::_FileRelease

protected

◆ _WriteReferencePlanesAsHidden

Dtk_bool catiav5w::WriteOptions::_WriteReferencePlanesAsHidden