tixi.h

Go to the documentation of this file.

/*
* Copyright (C) 2015 German Aerospace Center (DLR/SC)
*
* Created: 2010-08-13 Markus Litz <Markus.Litz@dlr.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifdef __cplusplus
extern "C" {
#endif

#if defined(WIN32)
#if defined (tixi3_EXPORTS)
#define DLL_EXPORT __declspec (dllexport)
#else
#define DLL_EXPORT
#endif
#else
#define DLL_EXPORT
#endif

// DEPRECATION MACRO
#if defined(_MSC_VER)
#define DEPRECATED __declspec(deprecated)
#elif defined(__GNUC__)
#define DEPRECATED __attribute__((deprecated))
#else
#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
#define DEPRECATED
#endif

/* \mainpage TIXI Manual
<b>Contents:</b>
  - \link Glossary Glossary\endlink
  - \link  XPathExamples XPath Examples\endlink
  - \link UsageExamples Usage\endlink
  - <a HREF="modules.html"  class="el">Function Documentation</a>
 */
/*
 @file   tixi.h
 @author Hans-Peter Kersken <Hans-Peter.Kersken@dlr.de>
         Markus Litz <Markus.Litz@dlr.de>,
         Markus Kunde <Markus.Kunde@dlr.de>,
         Arne Bachmann <Arne.Bachmann@dlr.de>,
 @date   Tue Feb 02 14:28:05 2009

 @brief  Definition of  <b>TIXI</b> the <b>TI</b>VA - <b>XML</b> - <b>I</b>nterface
*/
#ifndef TIXI_H
#define TIXI_H

typedef int TixiDocumentHandle;


enum ReturnCode
{
  SUCCESS,                    
  FAILED,                     
  INVALID_XML_NAME,           
  NOT_WELL_FORMED,            
  NOT_SCHEMA_COMPLIANT,       
  NOT_DTD_COMPLIANT,          
  INVALID_HANDLE,             
  INVALID_XPATH,              
  ELEMENT_NOT_FOUND,          
  INDEX_OUT_OF_RANGE,         
  NO_POINT_FOUND,             
  NOT_AN_ELEMENT,             
  ATTRIBUTE_NOT_FOUND,        
  OPEN_FAILED,                
  OPEN_SCHEMA_FAILED,         
  OPEN_DTD_FAILED,            
  CLOSE_FAILED,               
  ALREADY_SAVED,              
  ELEMENT_PATH_NOT_UNIQUE,    
  NO_ELEMENT_NAME,            
  NO_CHILDREN,                
  CHILD_NOT_FOUND,            
  EROROR_CREATE_ROOT_NODE,    
  DEALLOCATION_FAILED,        
  NO_NUMBER,                  
  NO_ATTRIBUTE_NAME,          
  STRING_TRUNCATED,           
  NON_MATCHING_NAME,          
  NON_MATCHING_SIZE,          
  MATRIX_DIMENSION_ERROR,     
  COORDINATE_NOT_FOUND,       
  UNKNOWN_STORAGE_MODE,        
  UID_NOT_UNIQUE,                
  UID_DONT_EXISTS,                
  UID_LINK_BROKEN,                
  INVALID_NAMESPACE_URI,          
  INVALID_NAMESPACE_PREFIX        
};

typedef enum ReturnCode ReturnCode;

enum StorageMode
{
  ROW_WISE,                   
  COLUMN_WISE                 
};


typedef enum StorageMode StorageMode;


enum OpenMode
{
  OPENMODE_PLAIN,                   
  OPENMODE_RECURSIVE                
};


typedef enum OpenMode OpenMode;
enum AddLinkMode
{
  ADDLINK_CREATE,                   
  ADDLINK_CREATE_AND_OPEN           
};


typedef enum AddLinkMode AddLinkMode;


enum MessageType
{
  MESSAGETYPE_ERROR,                 
  MESSAGETYPE_WARNING,               
  MESSAGETYPE_STATUS                 
};


typedef enum MessageType MessageType;

typedef void (*TixiPrintMsgFnc) (MessageType type, const char *msg);

DLL_EXPORT char* tixiGetVersion();



DLL_EXPORT ReturnCode tixiOpenDocument (const char *xmlFilename, TixiDocumentHandle * handle);



DLL_EXPORT ReturnCode tixiOpenDocumentRecursive (const char *xmlFilename, TixiDocumentHandle * handle, OpenMode oMode);


DLL_EXPORT ReturnCode tixiOpenDocumentFromHTTP (const char *httpURL, TixiDocumentHandle * handle);

DLL_EXPORT ReturnCode tixiCreateDocument (const char *rootElementName, TixiDocumentHandle * handle);

DLL_EXPORT ReturnCode tixiGetDocumentPath (TixiDocumentHandle handle, char** documentPath);

DLL_EXPORT ReturnCode tixiSaveDocument (TixiDocumentHandle handle, const char *xmlFilename);


DLL_EXPORT ReturnCode tixiSaveCompleteDocument (TixiDocumentHandle handle, const char *xmlFilename);


DLL_EXPORT ReturnCode tixiSaveAndRemoveDocument (TixiDocumentHandle handle, const char *xmlFilename);


DLL_EXPORT ReturnCode tixiCloseDocument (TixiDocumentHandle handle);


DLL_EXPORT ReturnCode tixiCloseAllDocuments ();

DLL_EXPORT ReturnCode tixiCleanup ();


DLL_EXPORT ReturnCode tixiExportDocumentAsString (const TixiDocumentHandle handle, char **text);


DLL_EXPORT ReturnCode tixiImportFromString (const char *xmlImportString, TixiDocumentHandle * handle);



DLL_EXPORT ReturnCode tixiSchemaValidateFromFile (const TixiDocumentHandle handle, const char *xsdFilename);

DLL_EXPORT ReturnCode tixiSchemaValidateWithDefaultsFromFile (const TixiDocumentHandle handle, const char *xsdFilename);

DLL_EXPORT ReturnCode tixiSchemaValidateFromString (const TixiDocumentHandle handle, const char *xsdString);


DLL_EXPORT ReturnCode tixiDTDValidate (const TixiDocumentHandle handle, const char *DTDFilename);
DLL_EXPORT ReturnCode tixiGetTextElement (const TixiDocumentHandle handle,
                                          const char *elementPath, char **text);


DLL_EXPORT ReturnCode tixiGetIntegerElement (const TixiDocumentHandle handle, const char *elementPath, int *number);

DLL_EXPORT ReturnCode tixiGetDoubleElement (const TixiDocumentHandle handle, const char *elementPath, double *number);


DLL_EXPORT ReturnCode tixiGetBooleanElement (const TixiDocumentHandle handle, const char *elementPath, int *boolean);


DLL_EXPORT ReturnCode tixiUpdateTextElement (const TixiDocumentHandle handle, const char *elementPath, const char *text);


DLL_EXPORT ReturnCode tixiUpdateDoubleElement (const TixiDocumentHandle handle, const char *elementPath, double number, const char *format);

DLL_EXPORT ReturnCode tixiUpdateIntegerElement (const TixiDocumentHandle handle, const char *elementPath, int number, const char *format);

DLL_EXPORT ReturnCode tixiUpdateBooleanElement (const TixiDocumentHandle handle, const char *elementPath, int boolean);


DLL_EXPORT ReturnCode tixiAddTextElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text);


DLL_EXPORT ReturnCode tixiAddTextElementNS (const TixiDocumentHandle handle, const char *parentPath,
                                            const char *qualifiedName, const char *namespaceURI, const char *text);



DLL_EXPORT ReturnCode tixiAddTextElementAtIndex (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text, int index);

DLL_EXPORT ReturnCode tixiAddTextElementNSAtIndex(const TixiDocumentHandle handle, const char *parentPath,
                                                  const char* qualifiedName, const char* namespaceURI, const char *text, int index);

DLL_EXPORT ReturnCode tixiAddBooleanElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int boolean);


DLL_EXPORT ReturnCode tixiAddBooleanElementNS (const TixiDocumentHandle handle, const char *parentPath,
                                               const char *qualifiedName, const char* namespaceURI, int boolean);


DLL_EXPORT ReturnCode tixiAddDoubleElement (const TixiDocumentHandle handle,
                                            const char *parentPath, const char *elementName,
                                            double number, const char *format);


DLL_EXPORT ReturnCode tixiAddDoubleElementNS (const TixiDocumentHandle handle,
                                              const char *parentPath, const char *qualifiedName, const char* namespaceURI,
                                              double number, const char *format);

DLL_EXPORT ReturnCode tixiAddIntegerElement (const TixiDocumentHandle handle,
                                             const char *parentPath, const char *elementName,
                                             int number, const char *format);


DLL_EXPORT ReturnCode tixiAddIntegerElementNS (const TixiDocumentHandle handle,
                                               const char *parentPath,
                                               const char *qualifiedName, const char *namespaceURI,
                                               int number, const char *format);


DLL_EXPORT ReturnCode tixiAddFloatVector (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const double *vector, const int numElements, const char* format);


DLL_EXPORT ReturnCode tixiUpdateFloatVector (const TixiDocumentHandle handle, const char *path, const double *vector, const int numElements, const char* format);


DLL_EXPORT ReturnCode tixiCreateElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName);


DLL_EXPORT ReturnCode tixiCreateElementNS (const TixiDocumentHandle handle, const char *parentPath,
                                           const char *qualifiedName, const char* namespaceURI);


DLL_EXPORT ReturnCode tixiCreateElementAtIndex (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int index);


DLL_EXPORT ReturnCode tixiCreateElementNSAtIndex (const TixiDocumentHandle handle, const char *parentPath,
                                                  const char *qualifiedName, int index, const char* namespaceURI);


DLL_EXPORT ReturnCode tixiRenameElement(const TixiDocumentHandle handle,
                                        const char* parentPath,
                                        const char* oldName,
                                        const char* newName);

DLL_EXPORT ReturnCode tixiRemoveElement (const TixiDocumentHandle handle, const char *elementPath);


DLL_EXPORT ReturnCode tixiGetNodeType (const TixiDocumentHandle handle,
                                       const char *nodePath, char **nodeType);


DLL_EXPORT ReturnCode tixiGetNamedChildrenCount (const TixiDocumentHandle handle,
                                                 const char *elementPath, const char *childName,
                                                 int *count);

DLL_EXPORT ReturnCode tixiGetChildNodeName (const TixiDocumentHandle handle,
                                            const char *parentElementPath, int index, char **name);

DLL_EXPORT ReturnCode tixiGetNumberOfChilds(const TixiDocumentHandle handle, const char *elementPath, int* nChilds);

DLL_EXPORT ReturnCode tixiSwapElements(const TixiDocumentHandle handle, const char* element1Path, const char* element2Path);


DLL_EXPORT ReturnCode tixiExportElementAsString (const TixiDocumentHandle handle, const char* elementPath, char **text);


DLL_EXPORT ReturnCode tixiImportElementFromString (const TixiDocumentHandle handle, const char *parentPath, const char *xmlImportString);


DLL_EXPORT ReturnCode tixiImportElementFromStringAtIndex (const TixiDocumentHandle handle, const char *parentPath, int index, const char *xmlImportString);



DLL_EXPORT ReturnCode tixiGetTextAttribute (const TixiDocumentHandle handle,
                                            const char *elementPath, const char *attributeName,
                                            char **text);

DLL_EXPORT ReturnCode tixiGetIntegerAttribute (const TixiDocumentHandle handle,
                                               const char *elementPath, const char *attributeName,
                                               int *number);

DLL_EXPORT ReturnCode tixiGetBooleanAttribute (const TixiDocumentHandle handle,
                                               const char *elementPath, const char *attributeName,
                                               int *boolean);

DLL_EXPORT ReturnCode tixiGetDoubleAttribute (const TixiDocumentHandle handle,
                                              const char *elementPath, const char *attributeName,
                                              double *number);




DLL_EXPORT ReturnCode tixiAddTextAttribute (const TixiDocumentHandle handle,
                                            const char *elementPath, const char *attributeName,
                                            const char *attributeValue);


DLL_EXPORT ReturnCode tixiAddDoubleAttribute (const TixiDocumentHandle handle,
                                              const char *elementPath, const char *attributeName,
                                              double number, const char *format);


DLL_EXPORT ReturnCode tixiAddIntegerAttribute (const TixiDocumentHandle handle,
                                               const char *elementPath, const char *attributeName,
                                               int number, const char *format);

DLL_EXPORT ReturnCode tixiRemoveAttribute (const TixiDocumentHandle handle,
                                           const char *elementPath, const char *attributeName);


DLL_EXPORT ReturnCode tixiGetNumberOfAttributes(const TixiDocumentHandle handle, const char *elementPath, int* nAttributes);


DLL_EXPORT ReturnCode tixiGetAttributeName(const TixiDocumentHandle handle, const char *elementPath, int attrIndex, char** attrName);



DLL_EXPORT ReturnCode tixiRegisterNamespace(const TixiDocumentHandle handle, const char* namespaceURI, const char* prefix);


DLL_EXPORT ReturnCode tixiRegisterNamespacesFromDocument(const TixiDocumentHandle handle);


DLL_EXPORT ReturnCode tixiSetElementNamespace(const TixiDocumentHandle handle, const char* elementPath,
                                              const char* namespaceURI, const char* prefix);


DLL_EXPORT ReturnCode tixiDeclareNamespace(const TixiDocumentHandle handle, const char* elementPath,
                                           const char* namespaceURI, const char* prefix);



DLL_EXPORT ReturnCode tixiAddExternalLink (const TixiDocumentHandle handle, const char *parentPath,
                                           const char *pathOrUrl, const char *filename, AddLinkMode mode);


DLL_EXPORT ReturnCode tixiRemoveExternalLinks(TixiDocumentHandle handle);

DLL_EXPORT ReturnCode tixiAddHeader (const TixiDocumentHandle handle, const char *toolName,
                                     const char *version, const char *authorName);



DLL_EXPORT ReturnCode tixiAddCpacsHeader (const TixiDocumentHandle handle, const char *name, const char *creator,
                                          const char *version, const char *description, const char * cpacsVersion);


DLL_EXPORT ReturnCode tixiCheckElement (const TixiDocumentHandle handle, const char *elementPath);


DLL_EXPORT ReturnCode tixiCheckDocumentHandle (const TixiDocumentHandle handle);

DLL_EXPORT ReturnCode tixiUsePrettyPrint(TixiDocumentHandle handle, int usePrettyPrint);

DLL_EXPORT ReturnCode tixiSetPrintMsgFunc(TixiPrintMsgFnc func);

DLL_EXPORT TixiPrintMsgFnc tixiGetPrintMsgFunc();


DLL_EXPORT ReturnCode tixiSetCacheEnabled(TixiDocumentHandle handle, int enabled);


DLL_EXPORT ReturnCode tixiAddDoubleListWithAttributes (const TixiDocumentHandle handle,
                                                       const char *parentPath,
                                                       const char *listName, const char *childName,
                                                       const char *childAttributeName,
                                                       const double *values, const char *format,
                                                       const char **attributes, int nValues);

DLL_EXPORT ReturnCode tixiGetVectorSize (const TixiDocumentHandle handle,
                                         const char *vectorPath, int *nElements);


DLL_EXPORT ReturnCode tixiGetFloatVector (const TixiDocumentHandle handle, const char *vectorPath,
                                          double **vectorArray, const int eNumber);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensions (const TixiDocumentHandle handle,
                                                         const char *arrayPath, int *dimensions);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionSizes (const TixiDocumentHandle handle, const char *arrayPath,
                                                             int *sizes, int *linearArraySize);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionNames (const TixiDocumentHandle handle,
                                                             const char *arrayPath, char **dimensionNames);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionValues (const TixiDocumentHandle handle, const char *arrayPath,
                                                              const int dimension, double *dimensionValues);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameters (const TixiDocumentHandle handle,
                                                         const char *arrayPath,
                                                         int *parameters);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameterNames (const TixiDocumentHandle handle,
                                                             const char *arrayPath, char **parameterNames);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArray (const TixiDocumentHandle handle, const char *arrayPath,
                                               const char *elementName, int arraySize, double **values);


DEPRECATED DLL_EXPORT double tixiGetArrayValue(const double *array,
                                               const int *dimSize,
                                               const int *dimPos,
                                               const int dims);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementCount (const TixiDocumentHandle handle, const char *arrayPath,
                                                           const char *elementName, int *elements);


DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementNames (const TixiDocumentHandle handle, const char *arrayPath,
                                                           const char *elementType, char **elementNames);


DLL_EXPORT ReturnCode tixiAddPoint (const TixiDocumentHandle handle, const char *pointParentPath,
                                    double x, double y, double z, const char *format);

DLL_EXPORT ReturnCode tixiGetPoint (const TixiDocumentHandle handle,
                                    const char *pointParentPath,
                                    double *x, double *y, double *z);



DLL_EXPORT ReturnCode tixiCheckAttribute(TixiDocumentHandle handle, const char *elementPath, const char *attributeName);



DLL_EXPORT ReturnCode tixiXSLTransformationToString(TixiDocumentHandle handle, const char *xslFilename, char **resultText);

DLL_EXPORT ReturnCode tixiXSLTransformationToFile(TixiDocumentHandle handle, const char *xslFilename, const char *resultFilename);



DLL_EXPORT ReturnCode tixiXPathEvaluateNodeNumber(TixiDocumentHandle handle, const char *xPathExpression, int *number);

DLL_EXPORT ReturnCode tixiXPathExpressionGetXPath(TixiDocumentHandle handle, const char *xPathExpression, int index, char** xPath);

DLL_EXPORT ReturnCode tixiXPathExpressionGetTextByIndex(TixiDocumentHandle handle, const char *xPathExpression, int elementNumber, char **text);



DLL_EXPORT ReturnCode tixiUIDCheckDuplicates(TixiDocumentHandle handle);


DLL_EXPORT ReturnCode tixiUIDCheckLinks(TixiDocumentHandle handle);

DLL_EXPORT ReturnCode tixiUIDGetXPath(TixiDocumentHandle handle, const char *uID, char **xPath);


DLL_EXPORT ReturnCode tixiUIDCheckExists(TixiDocumentHandle handle, const char *uID);


DLL_EXPORT ReturnCode tixiUIDSetToXPath(TixiDocumentHandle handle, const char *xPath, const char *uID);


#endif  /* TIXI_H */


#ifdef __cplusplus
}
#endif