General TIGL handling functions

Functions
TIGL_COMMON_EXPORT TiglReturnCode	tiglCloseCPACSConfiguration (TiglCPACSConfigurationHandle cpacsHandle)
	Closes a CPACS configuration and cleans up all memory used by the configuration. After closing a configuration the associated configuration handle is no longer valid. When the CPACS configuration has been closed, the companion tixi document can also be closed. More...
TIGL_COMMON_EXPORT TiglReturnCode	tiglGetCPACSTixiHandle (TiglCPACSConfigurationHandle cpacsHandle, TixiDocumentHandle *tixiHandlePtr)
	Returns the underlying TixiDocumentHandle for a given CPACS configuration handle. More...
TIGL_COMMON_EXPORT const char *	tiglGetVersion ()
	Returns the version number of this TIGL version. More...
TIGL_COMMON_EXPORT TiglReturnCode	tiglIsCPACSConfigurationHandleValid (TiglCPACSConfigurationHandle cpacsHandle, TiglBoolean *isValidPtr)
	Checks if a given CPACS configuration handle is a valid. More...
TIGL_COMMON_EXPORT TiglReturnCode	tiglOpenCPACSConfiguration (TixiDocumentHandle tixiHandle, const char *configurationUID, TiglCPACSConfigurationHandle *cpacsHandlePtr)
	Opens a CPACS configuration and builds up the data and geometry structure in memory. More...
TIGL_COMMON_EXPORT TiglReturnCode	tiglSaveCPACSConfiguration (const char *configurationUID, TiglCPACSConfigurationHandle cpacsHandle)
	Writes a CPACS configuration based on the data and geometry structure in memory. More...

Detailed Description

Function to open, create, and close CPACS-files.

Function Documentation

TIGL_COMMON_EXPORT TiglReturnCode tiglCloseCPACSConfiguration

(

TiglCPACSConfigurationHandle

cpacsHandle

)

Closes a CPACS configuration and cleans up all memory used by the configuration. After closing a configuration the associated configuration handle is no longer valid. When the CPACS configuration has been closed, the companion tixi document can also be closed.

Parameters

[in]

cpacsHandle

Handle for the CPACS configuration.

Returns

• TIGL_SUCCESS if successfully opened the CPACS configuration file
• TIGL_CLOSE_FAILED if closing of the CPACS configuration failed
• TIGL_NOT_FOUND if handle ist not found in handle container
• TIGL_ERROR if some other kind of error occurred

TIGL_COMMON_EXPORT TiglReturnCode tiglGetCPACSTixiHandle	(	TiglCPACSConfigurationHandle	cpacsHandle,
		TixiDocumentHandle *	tixiHandlePtr
	)

Returns the underlying TixiDocumentHandle for a given CPACS configuration handle.

Parameters

[in]	cpacsHandle	Handle for the CPACS configuration
[out]	tixiHandlePtr	Handle for the TIXI document associated with the CPACS configuration

Returns

• TIGL_SUCCESS if the TIXI handle was found
• TIGL_NOT_FOUND if the TIXI handle was not found
• TIGL_NULL_POINTER if tixiHandlePtr is an invalid null pointer
• TIGL_ERROR if some other kind of error occurred

TIGL_COMMON_EXPORT const char* tiglGetVersion

(

)

Returns the version number of this TIGL version.

Returns

• char* A string with the version number.

TIGL_COMMON_EXPORT TiglReturnCode tiglIsCPACSConfigurationHandleValid	(	TiglCPACSConfigurationHandle	cpacsHandle,
		TiglBoolean *	isValidPtr
	)

Checks if a given CPACS configuration handle is a valid.

Parameters

[in]	cpacsHandle	CPACS configuration handle to check
[out]	isValidPtr	Contains TIGL_TRUE, if handle is valid, otherwise contains TIGL_FALSE

Returns

• TIGL_SUCCESS if no error occurred

TIGL_COMMON_EXPORT TiglReturnCode tiglOpenCPACSConfiguration	(	TixiDocumentHandle	tixiHandle,
		const char *	configurationUID,
		TiglCPACSConfigurationHandle *	cpacsHandlePtr
	)

Opens a CPACS configuration and builds up the data and geometry structure in memory.

Parameters

[in]	tixiHandle	Handle to a TIXI document. The TIXI document should not be closed until the CPACS configuration is closed. First close the CPACS configuration, then the TIXI document.
[in]	configurationUID	The UID of the configuration that should be loaded by TIGL. Could be NULL or an empty string if the data set contains only one configuration.
[out]	cpacsHandlePtr	Handle to the CPACS configuration. This handle is used in calls to other TIGL functions.

Returns

• TIGL_SUCCESS if successfully opened the CPACS configuration
• TIGL_XML_ERROR if file is not well-formed or another XML error occurred
• TIGL_OPEN_FAILED if some other error occurred
• TIGL_NULL_POINTER if cpacsHandlePtr is an invalid null pointer
• TIGL_ERROR if some other kind of error occurred
• TIGL_INVALID_UID is the UID does not exist or an error orrcured with this configuration

TIGL_COMMON_EXPORT TiglReturnCode tiglSaveCPACSConfiguration	(	const char *	configurationUID,
		TiglCPACSConfigurationHandle	cpacsHandle
	)

Writes a CPACS configuration based on the data and geometry structure in memory.

Parameters

[in]	configurationUID	The UID of the configuration that should be written.
[in]	cpacsHandle	Handle to the CPACS configuration. This handle is used in calls to other TIGL functions.

Returns

• TIGL_SUCCESS if the CPACS configuration was successfully written
• TIGL_NULL_POINTER if cpacsHandle is an invalid null pointer
• TIGL_UNINITIALIZED if cpacsHandle is not managed by the CCPACSConfigurationManager
• TIGL_ERROR if some other kind of error occurred