DATAKIT API  V2025.1
Sat Write Functions

Functions

DtkErrorStatus satw_EndFile ()
 Ends the writing of the Sat file. More...
 
DtkErrorStatus satw_EndPart ()
 Ends the writing of a part. More...
 
DtkErrorStatus satw_InitFile (const Dtk_string &inFileOut, const satw_WriteOptions &inOptions=satw_WriteOptions())
 Initializes a file to be written. More...
 
DtkErrorStatus satw_InitPart ()
 Initializes the writing of a 3D part. More...
 
DtkErrorStatus satw_WriteBody (const Dtk_BodyPtr &inBody)
 Writes a Body. More...
 
DtkErrorStatus satw_WriteBody (Dtk_tab< Dtk_BodyPtr > inBodies, Dtk_bool inSewing=DTK_TRUE)
 Writes a liste of Bodies with sewing or not. More...
 

Detailed Description

Function Documentation

◆ satw_EndFile()

DtkErrorStatus satw_EndFile ( )

Ends the writing of the Sat file.

Returns
dtkNoError if OK

◆ satw_EndPart()

DtkErrorStatus satw_EndPart ( )

Ends the writing of a part.

Returns
dtkNoError if OK

◆ satw_InitFile()

DtkErrorStatus satw_InitFile ( const Dtk_string inFileOut,
const satw_WriteOptions inOptions = satw_WriteOptions() 
)

Initializes a file to be written.

Parameters
[in]inFileOut: Sat File to write
[in]inOptions: options for Sat writer
Returns
0 if OK , -4 if licence checking has failed

◆ satw_InitPart()

DtkErrorStatus satw_InitPart ( )

Initializes the writing of a 3D part.

Returns
dtkNoError if done Each product must have a 3D part, even empty : started by satw_InitPart, ended by satw_EndPart. Between them there can be 0, 1 or more Bodies to write (by satw_WriteBody)

◆ satw_WriteBody() [1/2]

DtkErrorStatus satw_WriteBody ( const Dtk_BodyPtr inBody)

Writes a Body.

Parameters
[in]inBody: the Body to be written
Returns
dtkNoError if done, dtkErrorUnspecified if inBody is null

◆ satw_WriteBody() [2/2]

DtkErrorStatus satw_WriteBody ( Dtk_tab< Dtk_BodyPtr inBodies,
Dtk_bool  inSewing = DTK_TRUE 
)

Writes a liste of Bodies with sewing or not.

Parameters
[in]inBodies: the Bodies to be written
[in]inSewing: DTK_TRUE if a sewing action of the bodies is performed, DTK_FALSE otherwise
Returns
dtkNoError if done, dtkErrorUnspecified if inBodies is empty