TiXI  3.1.1
tixi.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2015 German Aerospace Center (DLR/SC)
3 *
4 * Created: 2010-08-13 Markus Litz <Markus.Litz@dlr.de>
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 #ifdef __cplusplus
19 extern "C" {
20 #endif
21 
22 #if defined(WIN32)
23 #if defined (tixi3_EXPORTS)
24 #define DLL_EXPORT __declspec (dllexport)
25 #else
26 #define DLL_EXPORT
27 #endif
28 #else
29 #define DLL_EXPORT
30 #endif
31 
32 // DEPRECATION MACRO
33 #if defined(_MSC_VER)
34 #define DEPRECATED __declspec(deprecated)
35 #elif defined(__GNUC__)
36 #define DEPRECATED __attribute__((deprecated))
37 #else
38 #pragma message("WARNING: You need to implement DEPRECATED for this compiler")
39 #define DEPRECATED
40 #endif
41 
42 /* \mainpage TIXI Manual
43 <b>Contents:</b>
44  - \link Glossary Glossary\endlink
45  - \link XPathExamples XPath Examples\endlink
46  - \link UsageExamples Usage\endlink
47  - <a HREF="modules.html" class="el">Function Documentation</a>
48  */
49 /*
50  @file tixi.h
51  @author Hans-Peter Kersken <Hans-Peter.Kersken@dlr.de>
52  Markus Litz <Markus.Litz@dlr.de>,
53  Markus Kunde <Markus.Kunde@dlr.de>,
54  Arne Bachmann <Arne.Bachmann@dlr.de>,
55  @date Tue Feb 02 14:28:05 2009
56 
57  @brief Definition of <b>TIXI</b> the <b>TI</b>VA - <b>XML</b> - <b>I</b>nterface
58 */
240 #ifndef TIXI_H
241 #define TIXI_H
242 
246 typedef int TixiDocumentHandle;
247 
248 
259 {
346 };
347 
348 typedef enum ReturnCode ReturnCode;
349 
362 {
365 };
366 
367 
369 
370 
383 {
386 };
387 
388 
389 typedef enum OpenMode OpenMode;
390 
400 {
404 };
405 
406 
408 
418 typedef void (*TixiPrintMsgFnc) (MessageType type, const char *msg);
419 
429 DLL_EXPORT char* tixiGetVersion();
430 
431 
432 
461 DLL_EXPORT ReturnCode tixiOpenDocument (const char *xmlFilename, TixiDocumentHandle * handle);
462 
463 
464 
514 DLL_EXPORT ReturnCode tixiOpenDocumentRecursive (const char *xmlFilename, TixiDocumentHandle * handle, OpenMode oMode);
515 
516 
539 DLL_EXPORT ReturnCode tixiOpenDocumentFromHTTP (const char *httpURL, TixiDocumentHandle * handle);
540 
559 DLL_EXPORT ReturnCode tixiCreateDocument (const char *rootElementName, TixiDocumentHandle * handle);
560 
575 DLL_EXPORT ReturnCode tixiGetDocumentPath (TixiDocumentHandle handle, char** documentPath);
576 
602 DLL_EXPORT ReturnCode tixiSaveDocument (TixiDocumentHandle handle, const char *xmlFilename);
603 
604 
631 DLL_EXPORT ReturnCode tixiSaveCompleteDocument (TixiDocumentHandle handle, const char *xmlFilename);
632 
633 
659 DLL_EXPORT ReturnCode tixiSaveAndRemoveDocument (TixiDocumentHandle handle, const char *xmlFilename);
660 
661 
682 DLL_EXPORT ReturnCode tixiCloseDocument (TixiDocumentHandle handle);
683 
684 
701 DLL_EXPORT ReturnCode tixiCloseAllDocuments ();
702 
706 DLL_EXPORT ReturnCode tixiCleanup ();
707 
708 
731 DLL_EXPORT ReturnCode tixiExportDocumentAsString (const TixiDocumentHandle handle, char **text);
732 
733 
753 DLL_EXPORT ReturnCode tixiImportFromString (const char *xmlImportString, TixiDocumentHandle * handle);
754 
762 
763 
789 DLL_EXPORT ReturnCode tixiSchemaValidateFromFile (const TixiDocumentHandle handle, const char *xsdFilename);
790 
818 DLL_EXPORT ReturnCode tixiSchemaValidateWithDefaultsFromFile (const TixiDocumentHandle handle, const char *xsdFilename);
819 
847 DLL_EXPORT ReturnCode tixiSchemaValidateFromString (const TixiDocumentHandle handle, const char *xsdString);
848 
849 
874 DLL_EXPORT ReturnCode tixiDTDValidate (const TixiDocumentHandle handle, const char *DTDFilename);
915 DLL_EXPORT ReturnCode tixiGetTextElement (const TixiDocumentHandle handle,
916  const char *elementPath, char **text);
917 
918 
947 DLL_EXPORT ReturnCode tixiGetIntegerElement (const TixiDocumentHandle handle, const char *elementPath, int *number);
948 
976 DLL_EXPORT ReturnCode tixiGetDoubleElement (const TixiDocumentHandle handle, const char *elementPath, double *number);
977 
978 
1009 DLL_EXPORT ReturnCode tixiGetBooleanElement (const TixiDocumentHandle handle, const char *elementPath, int *boolean);
1010 
1011 
1039 DLL_EXPORT ReturnCode tixiUpdateTextElement (const TixiDocumentHandle handle, const char *elementPath, const char *text);
1040 
1041 
1072 DLL_EXPORT ReturnCode tixiUpdateDoubleElement (const TixiDocumentHandle handle, const char *elementPath, double number, const char *format);
1073 
1104 DLL_EXPORT ReturnCode tixiUpdateIntegerElement (const TixiDocumentHandle handle, const char *elementPath, int number, const char *format);
1105 
1133 DLL_EXPORT ReturnCode tixiUpdateBooleanElement (const TixiDocumentHandle handle, const char *elementPath, int boolean);
1134 
1135 
1168 DLL_EXPORT ReturnCode tixiAddTextElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text);
1169 
1170 
1211 DLL_EXPORT ReturnCode tixiAddTextElementNS (const TixiDocumentHandle handle, const char *parentPath,
1212  const char *qualifiedName, const char *namespaceURI, const char *text);
1213 
1214 
1215 
1252 DLL_EXPORT ReturnCode tixiAddTextElementAtIndex (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text, int index);
1253 
1297 DLL_EXPORT ReturnCode tixiAddTextElementNSAtIndex(const TixiDocumentHandle handle, const char *parentPath,
1298  const char* qualifiedName, const char* namespaceURI, const char *text, int index);
1299 
1332 DLL_EXPORT ReturnCode tixiAddBooleanElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int boolean);
1333 
1334 
1375 DLL_EXPORT ReturnCode tixiAddBooleanElementNS (const TixiDocumentHandle handle, const char *parentPath,
1376  const char *qualifiedName, const char* namespaceURI, int boolean);
1377 
1378 
1410 DLL_EXPORT ReturnCode tixiAddDoubleElement (const TixiDocumentHandle handle,
1411  const char *parentPath, const char *elementName,
1412  double number, const char *format);
1413 
1414 
1454 DLL_EXPORT ReturnCode tixiAddDoubleElementNS (const TixiDocumentHandle handle,
1455  const char *parentPath, const char *qualifiedName, const char* namespaceURI,
1456  double number, const char *format);
1457 
1489 DLL_EXPORT ReturnCode tixiAddIntegerElement (const TixiDocumentHandle handle,
1490  const char *parentPath, const char *elementName,
1491  int number, const char *format);
1492 
1493 
1533 DLL_EXPORT ReturnCode tixiAddIntegerElementNS (const TixiDocumentHandle handle,
1534  const char *parentPath,
1535  const char *qualifiedName, const char *namespaceURI,
1536  int number, const char *format);
1537 
1538 
1583 DLL_EXPORT ReturnCode tixiAddFloatVector (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const double *vector, const int numElements, const char* format);
1584 
1585 
1622 DLL_EXPORT ReturnCode tixiUpdateFloatVector (const TixiDocumentHandle handle, const char *path, const double *vector, const int numElements, const char* format);
1623 
1624 
1653 DLL_EXPORT ReturnCode tixiCreateElement (const TixiDocumentHandle handle, const char *parentPath, const char *elementName);
1654 
1655 
1692 DLL_EXPORT ReturnCode tixiCreateElementNS (const TixiDocumentHandle handle, const char *parentPath,
1693  const char *qualifiedName, const char* namespaceURI);
1694 
1695 
1727 DLL_EXPORT ReturnCode tixiCreateElementAtIndex (const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int index);
1728 
1729 
1769 DLL_EXPORT ReturnCode tixiCreateElementNSAtIndex (const TixiDocumentHandle handle, const char *parentPath,
1770  const char *qualifiedName, int index, const char* namespaceURI);
1771 
1772 
1794 DLL_EXPORT ReturnCode tixiRenameElement(const TixiDocumentHandle handle,
1795  const char* parentPath,
1796  const char* oldName,
1797  const char* newName);
1798 
1822 DLL_EXPORT ReturnCode tixiRemoveElement (const TixiDocumentHandle handle, const char *elementPath);
1823 
1824 
1847 DLL_EXPORT ReturnCode tixiGetNodeType (const TixiDocumentHandle handle,
1848  const char *nodePath, char **nodeType);
1849 
1850 
1875 DLL_EXPORT ReturnCode tixiGetNamedChildrenCount (const TixiDocumentHandle handle,
1876  const char *elementPath, const char *childName,
1877  int *count);
1878 
1903 DLL_EXPORT ReturnCode tixiGetChildNodeName (const TixiDocumentHandle handle,
1904  const char *parentElementPath, int index, char **name);
1905 
1926 DLL_EXPORT ReturnCode tixiGetNumberOfChilds(const TixiDocumentHandle handle, const char *elementPath, int* nChilds);
1927 
1946 DLL_EXPORT ReturnCode tixiSwapElements(const TixiDocumentHandle handle, const char* element1Path, const char* element2Path);
1947 
1958 
1992 DLL_EXPORT ReturnCode tixiGetTextAttribute (const TixiDocumentHandle handle,
1993  const char *elementPath, const char *attributeName,
1994  char **text);
1995 
2029 DLL_EXPORT ReturnCode tixiGetIntegerAttribute (const TixiDocumentHandle handle,
2030  const char *elementPath, const char *attributeName,
2031  int *number);
2032 
2066 DLL_EXPORT ReturnCode tixiGetBooleanAttribute (const TixiDocumentHandle handle,
2067  const char *elementPath, const char *attributeName,
2068  int *boolean);
2069 
2103 DLL_EXPORT ReturnCode tixiGetDoubleAttribute (const TixiDocumentHandle handle,
2104  const char *elementPath, const char *attributeName,
2105  double *number);
2106 
2107 
2108 
2109 
2145 DLL_EXPORT ReturnCode tixiAddTextAttribute (const TixiDocumentHandle handle,
2146  const char *elementPath, const char *attributeName,
2147  const char *attributeValue);
2148 
2149 
2190 DLL_EXPORT ReturnCode tixiAddDoubleAttribute (const TixiDocumentHandle handle,
2191  const char *elementPath, const char *attributeName,
2192  double number, const char *format);
2193 
2194 
2234 DLL_EXPORT ReturnCode tixiAddIntegerAttribute (const TixiDocumentHandle handle,
2235  const char *elementPath, const char *attributeName,
2236  int number, const char *format);
2237 
2266 DLL_EXPORT ReturnCode tixiRemoveAttribute (const TixiDocumentHandle handle,
2267  const char *elementPath, const char *attributeName);
2268 
2269 
2290 DLL_EXPORT ReturnCode tixiGetNumberOfAttributes(const TixiDocumentHandle handle, const char *elementPath, int* nAttributes);
2291 
2292 
2314 DLL_EXPORT ReturnCode tixiGetAttributeName(const TixiDocumentHandle handle, const char *elementPath, int attrIndex, char** attrName);
2315 
2381 
2382 
2405 DLL_EXPORT ReturnCode tixiRegisterNamespace(const TixiDocumentHandle handle, const char* namespaceURI, const char* prefix);
2406 
2407 
2428 DLL_EXPORT ReturnCode tixiRegisterNamespacesFromDocument(const TixiDocumentHandle handle);
2429 
2430 
2451 DLL_EXPORT ReturnCode tixiSetElementNamespace(const TixiDocumentHandle handle, const char* elementPath,
2452  const char* namespaceURI, const char* prefix);
2453 
2454 
2478 DLL_EXPORT ReturnCode tixiDeclareNamespace(const TixiDocumentHandle handle, const char* elementPath,
2479  const char* namespaceURI, const char* prefix);
2480 
2488 
2489 
2510 DLL_EXPORT ReturnCode tixiAddExternalLink (const TixiDocumentHandle handle, const char *parentPath,
2511  const char *url, const char *fileFormat);
2512 
2513 
2611 DLL_EXPORT ReturnCode tixiRemoveExternalLinks(TixiDocumentHandle handle);
2612 
2636 DLL_EXPORT ReturnCode tixiAddHeader (const TixiDocumentHandle handle, const char *toolName,
2637  const char *version, const char *authorName);
2638 
2639 
2640 
2665 DLL_EXPORT ReturnCode tixiAddCpacsHeader (const TixiDocumentHandle handle, const char *name, const char *creator,
2666  const char *version, const char *description, const char * cpacsVersion);
2667 
2668 
2683 DLL_EXPORT ReturnCode tixiCheckElement (const TixiDocumentHandle handle, const char *elementPath);
2684 
2685 
2699 DLL_EXPORT ReturnCode tixiCheckDocumentHandle (const TixiDocumentHandle handle);
2700 
2721 DLL_EXPORT ReturnCode tixiUsePrettyPrint(TixiDocumentHandle handle, int usePrettyPrint);
2722 
2745 
2753 
2754 
2768 DLL_EXPORT ReturnCode tixiSetCacheEnabled(TixiDocumentHandle handle, int enabled);
2769 
2778 
2818 DLL_EXPORT ReturnCode tixiAddDoubleListWithAttributes (const TixiDocumentHandle handle,
2819  const char *parentPath,
2820  const char *listName, const char *childName,
2821  const char *childAttributeName,
2822  const double *values, const char *format,
2823  const char **attributes, int nValues);
2824 
2846 DLL_EXPORT ReturnCode tixiGetVectorSize (const TixiDocumentHandle handle,
2847  const char *vectorPath, int *nElements);
2848 
2849 
2877 DLL_EXPORT ReturnCode tixiGetFloatVector (const TixiDocumentHandle handle, const char *vectorPath,
2878  double **vectorArray, const int eNumber);
2879 
2880 
2929 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensions (const TixiDocumentHandle handle,
2930  const char *arrayPath, int *dimensions);
2931 
2932 
2962 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionSizes (const TixiDocumentHandle handle, const char *arrayPath,
2963  int *sizes, int *linearArraySize);
2964 
2965 
2994 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionNames (const TixiDocumentHandle handle,
2995  const char *arrayPath, char **dimensionNames);
2996 
2997 
3026 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionValues (const TixiDocumentHandle handle, const char *arrayPath,
3027  const int dimension, double *dimensionValues);
3028 
3029 
3057 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameters (const TixiDocumentHandle handle,
3058  const char *arrayPath,
3059  int *parameters);
3060 
3061 
3089 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameterNames (const TixiDocumentHandle handle,
3090  const char *arrayPath, char **parameterNames);
3091 
3092 
3127 DEPRECATED DLL_EXPORT ReturnCode tixiGetArray (const TixiDocumentHandle handle, const char *arrayPath,
3128  const char *elementName, int arraySize, double **values);
3129 
3130 
3149 DEPRECATED DLL_EXPORT double tixiGetArrayValue(const double *array,
3150  const int *dimSize,
3151  const int *dimPos,
3152  const int dims);
3153 
3154 
3182 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementCount (const TixiDocumentHandle handle, const char *arrayPath,
3183  const char *elementName, int *elements);
3184 
3185 
3213 DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementNames (const TixiDocumentHandle handle, const char *arrayPath,
3214  const char *elementType, char **elementNames);
3215 
3216 
3252 DLL_EXPORT ReturnCode tixiAddPoint (const TixiDocumentHandle handle, const char *pointParentPath,
3253  double x, double y, double z, const char *format);
3254 
3295 DLL_EXPORT ReturnCode tixiGetPoint (const TixiDocumentHandle handle,
3296  const char *pointParentPath,
3297  double *x, double *y, double *z);
3298 
3299 
3300 
3323 DLL_EXPORT ReturnCode tixiCheckAttribute(TixiDocumentHandle handle, const char *elementPath, const char *attributeName);
3324 
3325 
3332 
3348 DLL_EXPORT ReturnCode tixiXSLTransformationToString(TixiDocumentHandle handle, const char *xslFilename, char **resultText);
3349 
3365 DLL_EXPORT ReturnCode tixiXSLTransformationToFile(TixiDocumentHandle handle, const char *xslFilename, const char *resultFilename);
3366 
3367 
3375 
3391 DLL_EXPORT ReturnCode tixiXPathEvaluateNodeNumber(TixiDocumentHandle handle, const char *xPathExpression, int *number);
3392 
3406 DLL_EXPORT ReturnCode tixiXPathExpressionGetXPath(TixiDocumentHandle handle, const char *xPathExpression, int index, char** xPath);
3407 
3431 DLL_EXPORT ReturnCode tixiXPathExpressionGetTextByIndex(TixiDocumentHandle handle, const char *xPathExpression, int elementNumber, char **text);
3432 
3433 
3441 
3456 DLL_EXPORT ReturnCode tixiUIDCheckDuplicates(TixiDocumentHandle handle);
3457 
3458 
3474 DLL_EXPORT ReturnCode tixiUIDCheckLinks(TixiDocumentHandle handle);
3475 
3496 DLL_EXPORT ReturnCode tixiUIDGetXPath(TixiDocumentHandle handle, const char *uID, char **xPath);
3497 
3498 
3515 DLL_EXPORT ReturnCode tixiUIDCheckExists(TixiDocumentHandle handle, const char *uID);
3516 
3517 
3540 DLL_EXPORT ReturnCode tixiUIDSetToXPath(TixiDocumentHandle handle, const char *xPath, const char *uID);
3541 
3542 
3546 #endif /* TIXI_H */
3547 
3548 
3549 #ifdef __cplusplus
3550 }
3551 #endif
DLL_EXPORT ReturnCode tixiSetElementNamespace(const TixiDocumentHandle handle, const char *elementPath, const char *namespaceURI, const char *prefix)
This function sets the namespace for the specified element.
DLL_EXPORT ReturnCode tixiCheckAttribute(TixiDocumentHandle handle, const char *elementPath, const char *attributeName)
Checks the existence of an element&#39;s attribute.
DLL_EXPORT ReturnCode tixiUIDCheckExists(TixiDocumentHandle handle, const char *uID)
Checks if a uID exists.
DLL_EXPORT ReturnCode tixiAddIntegerElement(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int number, const char *format)
Creates an element which holds an integer.
DLL_EXPORT ReturnCode tixiGetIntegerAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, int *number)
Retrieves value of an element&#39;s attribute as an integer.
DLL_EXPORT ReturnCode tixiDTDValidate(const TixiDocumentHandle handle, const char *DTDFilename)
Validate XML-document against a DTD.
DLL_EXPORT ReturnCode tixiCreateElementAtIndex(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int index)
Creates an empty element at a given index.
DLL_EXPORT ReturnCode tixiSaveAndRemoveDocument(TixiDocumentHandle handle, const char *xmlFilename)
Write XML-document with all external data to disk.
DLL_EXPORT ReturnCode tixiCheckDocumentHandle(const TixiDocumentHandle handle)
Checks for validity of a document handle.
DLL_EXPORT ReturnCode tixiAddBooleanElementNS(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI, int boolean)
Creates an element in the given namesoace and sets the value to "true" or "false".
DLL_EXPORT ReturnCode tixiAddExternalLink(const TixiDocumentHandle handle, const char *parentPath, const char *url, const char *fileFormat)
Add a name of an external file as a url.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionValues(const TixiDocumentHandle handle, const char *arrayPath, const int dimension, double *dimensionValues)
Retrieves the selected dimension&#39;s values (e.g. separate allowed angles etc.).
DLL_EXPORT ReturnCode tixiXPathExpressionGetXPath(TixiDocumentHandle handle, const char *xPathExpression, int index, char **xPath)
Evaluates a XPath expression and the xPath for the i-th result.
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)
High level routine to write a list of elements with attributes.
DEPRECATED DLL_EXPORT double tixiGetArrayValue(const double *array, const int *dimSize, const int *dimPos, const int dims)
Getter function to take one multidimensionally specified element from a complete array, retrieved earlier.
DLL_EXPORT ReturnCode tixiCreateElement(const TixiDocumentHandle handle, const char *parentPath, const char *elementName)
Creates an empty element.
DLL_EXPORT ReturnCode tixiXPathExpressionGetTextByIndex(TixiDocumentHandle handle, const char *xPathExpression, int elementNumber, char **text)
Evaluates a XPath expression and returns the text content of the resultnode matching this xpath expre...
DLL_EXPORT ReturnCode tixiExportDocumentAsString(const TixiDocumentHandle handle, char **text)
Returns the Document as one text.
DLL_EXPORT ReturnCode tixiAddIntegerElementNS(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI, int number, const char *format)
Creates an element which holds an integer in the given namespace.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementCount(const TixiDocumentHandle handle, const char *arrayPath, const char *elementName, int *elements)
Helper function.
DLL_EXPORT ReturnCode tixiGetIntegerElement(const TixiDocumentHandle handle, const char *elementPath, int *number)
Retrieve integer content of an element.
DLL_EXPORT ReturnCode tixiAddBooleanElement(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, int boolean)
Creates an element and sets the value to "true" or "false".
DLL_EXPORT ReturnCode tixiImportFromString(const char *xmlImportString, TixiDocumentHandle *handle)
Imports a char-string into a new tixi-document.
DLL_EXPORT ReturnCode tixiGetTextAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, char **text)
Retrieves value of an element&#39;s attribute as a string.
DLL_EXPORT ReturnCode tixiAddIntegerAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, int number, const char *format)
Adds an attribute with an integer number value to an element.
DLL_EXPORT ReturnCode tixiUIDGetXPath(TixiDocumentHandle handle, const char *uID, char **xPath)
Returns the XPath to given uID.
#define DEPRECATED
Definition: tixi.h:39
DLL_EXPORT ReturnCode tixiUsePrettyPrint(TixiDocumentHandle handle, int usePrettyPrint)
Sets Pretty print on or off.
DLL_EXPORT ReturnCode tixiRegisterNamespace(const TixiDocumentHandle handle, const char *namespaceURI, const char *prefix)
Registers the given namespace and its prefix.
DLL_EXPORT ReturnCode tixiGetFloatVector(const TixiDocumentHandle handle, const char *vectorPath, double **vectorArray, const int eNumber)
Retrieves a vector.
DLL_EXPORT ReturnCode tixiGetVectorSize(const TixiDocumentHandle handle, const char *vectorPath, int *nElements)
Retrieves the size of an Vector.
DLL_EXPORT ReturnCode tixiSwapElements(const TixiDocumentHandle handle, const char *element1Path, const char *element2Path)
Swaps to xml elements with each other.
DLL_EXPORT ReturnCode tixiCheckElement(const TixiDocumentHandle handle, const char *elementPath)
Checks if the given element exists.
DLL_EXPORT ReturnCode tixiGetNodeType(const TixiDocumentHandle handle, const char *nodePath, char **nodeType)
Returns the number of child elements beneath a given path.
DLL_EXPORT ReturnCode tixiAddTextAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, const char *attributeValue)
Adds an attribute with a string value to an element.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameterNames(const TixiDocumentHandle handle, const char *arrayPath, char **parameterNames)
Retrieves names of all parameters.
DLL_EXPORT ReturnCode tixiRemoveElement(const TixiDocumentHandle handle, const char *elementPath)
Removes an element.
DLL_EXPORT ReturnCode tixiGetPoint(const TixiDocumentHandle handle, const char *pointParentPath, double *x, double *y, double *z)
Reads a point element but ignores error if an incomplete point is encountered.
DLL_EXPORT ReturnCode tixiAddTextElement(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text)
Creates an element holding text.
DLL_EXPORT ReturnCode tixiUpdateTextElement(const TixiDocumentHandle handle, const char *elementPath, const char *text)
Updates the text content of an element.
DLL_EXPORT ReturnCode tixiAddDoubleElementNS(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI, double number, const char *format)
Creates an element which holds a floating point number in the given namespace.
DLL_EXPORT ReturnCode tixiCloseAllDocuments()
Close all open documents.
DLL_EXPORT ReturnCode tixiXSLTransformationToString(TixiDocumentHandle handle, const char *xslFilename, char **resultText)
Performs a XML transformation .
int TixiDocumentHandle
Definition: tixi.h:246
#define DLL_EXPORT
Definition: tixi.h:29
DLL_EXPORT ReturnCode tixiSchemaValidateFromFile(const TixiDocumentHandle handle, const char *xsdFilename)
Validate XML-document against an XML-schema.
DLL_EXPORT ReturnCode tixiOpenDocument(const char *xmlFilename, TixiDocumentHandle *handle)
Open an XML-file for reading.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensions(const TixiDocumentHandle handle, const char *arrayPath, int *dimensions)
Retrieves the number of dimensions of an Array.
DLL_EXPORT ReturnCode tixiDeclareNamespace(const TixiDocumentHandle handle, const char *elementPath, const char *namespaceURI, const char *prefix)
This function adds a namespace declaration inside the tag of specified element.
StorageMode
Definition: tixi.h:361
DLL_EXPORT ReturnCode tixiUIDCheckLinks(TixiDocumentHandle handle)
Performs a check over all nodes with the uID "isLink" and check if the corresponding uid exists in th...
DLL_EXPORT ReturnCode tixiCleanup()
Closes the xml2 library and frees its allocated variables.
DLL_EXPORT ReturnCode tixiGetChildNodeName(const TixiDocumentHandle handle, const char *parentElementPath, int index, char **name)
Returns the name of a child node beneath a given path.
DLL_EXPORT ReturnCode tixiAddFloatVector(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const double *vector, const int numElements, const char *format)
Creates an element holding an vector.
DLL_EXPORT ReturnCode tixiGetNumberOfAttributes(const TixiDocumentHandle handle, const char *elementPath, int *nAttributes)
Returns the number of attributes of a given node.
DLL_EXPORT ReturnCode tixiUpdateDoubleElement(const TixiDocumentHandle handle, const char *elementPath, double number, const char *format)
Updates the double content of an element.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArray(const TixiDocumentHandle handle, const char *arrayPath, const char *elementName, int arraySize, double **values)
Reads in an array. The memory management of the array is done by tixi.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionSizes(const TixiDocumentHandle handle, const char *arrayPath, int *sizes, int *linearArraySize)
Retrieves the sizes of all dimensions of the array definition, and the overall array size (product of...
DLL_EXPORT ReturnCode tixiAddDoubleAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, double number, const char *format)
Adds an attribute with a floating point number value to an element.
DLL_EXPORT ReturnCode tixiAddTextElementNS(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI, const char *text)
Creates an element holding text within the given namespace.
DLL_EXPORT ReturnCode tixiGetBooleanAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, int *boolean)
Retrieves value of an element&#39;s attribute as an boolean.
void(* TixiPrintMsgFnc)(MessageType type, const char *msg)
Definition: tixi.h:418
DLL_EXPORT ReturnCode tixiUIDSetToXPath(TixiDocumentHandle handle, const char *xPath, const char *uID)
Sets a uID attribute to a node, specified via its XPath.
DLL_EXPORT ReturnCode tixiSetPrintMsgFunc(TixiPrintMsgFnc func)
Reroutes all messages of tixi to the message function func.
DLL_EXPORT ReturnCode tixiGetAttributeName(const TixiDocumentHandle handle, const char *elementPath, int attrIndex, char **attrName)
Returns the name of an attribute beneath a given path.
DLL_EXPORT ReturnCode tixiCloseDocument(TixiDocumentHandle handle)
Close an XML-document.
DLL_EXPORT ReturnCode tixiSaveDocument(TixiDocumentHandle handle, const char *xmlFilename)
Write XML-document to disk.
DLL_EXPORT ReturnCode tixiAddDoubleElement(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, double number, const char *format)
Creates an element which holds a floating point number.
DLL_EXPORT ReturnCode tixiRegisterNamespacesFromDocument(const TixiDocumentHandle handle)
Registers all prefixed namespaces of the xml document to the parser.
DLL_EXPORT ReturnCode tixiCreateDocument(const char *rootElementName, TixiDocumentHandle *handle)
Create an XML-document.
DLL_EXPORT ReturnCode tixiGetDocumentPath(TixiDocumentHandle handle, char **documentPath)
Returns the file path to the document.
DLL_EXPORT ReturnCode tixiSchemaValidateFromString(const TixiDocumentHandle handle, const char *xsdString)
Validate XML-document against an XML-schema.
DLL_EXPORT char * tixiGetVersion()
Returns the version number of this TIXI version.
DLL_EXPORT ReturnCode tixiCreateElementNS(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI)
Creates an empty element in the specified namespace.
DLL_EXPORT ReturnCode tixiOpenDocumentFromHTTP(const char *httpURL, TixiDocumentHandle *handle)
Open an XML-file for reading from a http web resource.
DLL_EXPORT ReturnCode tixiAddTextElementNSAtIndex(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, const char *namespaceURI, const char *text, int index)
Creates an element holding text at a given index in the specified namespace.
DLL_EXPORT ReturnCode tixiXPathEvaluateNodeNumber(TixiDocumentHandle handle, const char *xPathExpression, int *number)
Evaluates a XPath expression and returns the number of result nodes matching this xpath expression...
DLL_EXPORT ReturnCode tixiGetTextElement(const TixiDocumentHandle handle, const char *elementPath, char **text)
Retrieve text content of an element.
DLL_EXPORT ReturnCode tixiUpdateBooleanElement(const TixiDocumentHandle handle, const char *elementPath, int boolean)
Updates the boolean content of an element.
DLL_EXPORT ReturnCode tixiGetDoubleElement(const TixiDocumentHandle handle, const char *elementPath, double *number)
Retrieve floating point content of an element.
DLL_EXPORT ReturnCode tixiSetCacheEnabled(TixiDocumentHandle handle, int enabled)
Enables the internal xPath cache.
DLL_EXPORT ReturnCode tixiAddCpacsHeader(const TixiDocumentHandle handle, const char *name, const char *creator, const char *version, const char *description, const char *cpacsVersion)
Add CPACS header to XML-file.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionNames(const TixiDocumentHandle handle, const char *arrayPath, char **dimensionNames)
Retrieves the names of all dimensions.
DLL_EXPORT ReturnCode tixiUIDCheckDuplicates(TixiDocumentHandle handle)
Performs a check over all UIDs and checks for duplicates.
DLL_EXPORT ReturnCode tixiAddPoint(const TixiDocumentHandle handle, const char *pointParentPath, double x, double y, double z, const char *format)
Adds an element containing the 3D cartesian coordinates of a point.
DLL_EXPORT ReturnCode tixiRemoveExternalLinks(TixiDocumentHandle handle)
Removes all link attributes to external files.
DLL_EXPORT ReturnCode tixiUpdateFloatVector(const TixiDocumentHandle handle, const char *path, const double *vector, const int numElements, const char *format)
Updates the data of a vector element.
DLL_EXPORT ReturnCode tixiGetNumberOfChilds(const TixiDocumentHandle handle, const char *elementPath, int *nChilds)
Returns the number of child elements beneath a given path.
ReturnCode
Definition: tixi.h:258
DLL_EXPORT ReturnCode tixiGetNamedChildrenCount(const TixiDocumentHandle handle, const char *elementPath, const char *childName, int *count)
Returns the number of children elements with the same name.
DLL_EXPORT ReturnCode tixiAddHeader(const TixiDocumentHandle handle, const char *toolName, const char *version, const char *authorName)
Add header to XML-file.
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameters(const TixiDocumentHandle handle, const char *arrayPath, int *parameters)
Retrieves the number of parameters of an array.
OpenMode
Definition: tixi.h:382
DLL_EXPORT ReturnCode tixiOpenDocumentRecursive(const char *xmlFilename, TixiDocumentHandle *handle, OpenMode oMode)
Open an XML-file for reading. It acts like tixiOpenDocument.
Definition: tixi.h:363
DLL_EXPORT ReturnCode tixiSchemaValidateWithDefaultsFromFile(const TixiDocumentHandle handle, const char *xsdFilename)
Validate XML-document against an XML-schema and insert missing default elements and attributes...
DLL_EXPORT TixiPrintMsgFnc tixiGetPrintMsgFunc()
Returns the currently registered message handler function.
DLL_EXPORT ReturnCode tixiRemoveAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName)
Removes an attribute.
DLL_EXPORT ReturnCode tixiCreateElementNSAtIndex(const TixiDocumentHandle handle, const char *parentPath, const char *qualifiedName, int index, const char *namespaceURI)
Creates an empty element at a given index in the specified namespace.
Definition: tixi.h:260
DLL_EXPORT ReturnCode tixiSaveCompleteDocument(TixiDocumentHandle handle, const char *xmlFilename)
Write XML-document with all external data to disk.
DLL_EXPORT ReturnCode tixiGetBooleanElement(const TixiDocumentHandle handle, const char *elementPath, int *boolean)
Retrieve boolean content of an element.
DLL_EXPORT ReturnCode tixiXSLTransformationToFile(TixiDocumentHandle handle, const char *xslFilename, const char *resultFilename)
Performs a XML transformation and saves the result to resultFilename.
Definition: tixi.h:262
DLL_EXPORT ReturnCode tixiAddTextElementAtIndex(const TixiDocumentHandle handle, const char *parentPath, const char *elementName, const char *text, int index)
Creates an element holding text at a given index.
MessageType
Definition: tixi.h:399
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementNames(const TixiDocumentHandle handle, const char *arrayPath, const char *elementType, char **elementNames)
Helper function.
DLL_EXPORT ReturnCode tixiGetDoubleAttribute(const TixiDocumentHandle handle, const char *elementPath, const char *attributeName, double *number)
Retrieves value of an element&#39;s attribute as a floating point number.
DLL_EXPORT ReturnCode tixiUpdateIntegerElement(const TixiDocumentHandle handle, const char *elementPath, int number, const char *format)
Updates the double content of an element.
DLL_EXPORT ReturnCode tixiRenameElement(const TixiDocumentHandle handle, const char *parentPath, const char *oldName, const char *newName)
Renames an element.

Generated Fri Jul 24 2020 12:00:00, by Martin Siggel DLR