TiXI  3.3.0
High Level Functions

Functions

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. More...
 
DLL_EXPORT ReturnCode tixiGetVectorSize (const TixiDocumentHandle handle, const char *vectorPath, int *nElements)
 Retrieves the size of an Vector. More...
 
DLL_EXPORT ReturnCode tixiGetFloatVector (const TixiDocumentHandle handle, const char *vectorPath, double **vectorArray, const int eNumber)
 Retrieves a vector. More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensions (const TixiDocumentHandle handle, const char *arrayPath, int *dimensions)
 Retrieves the number of dimensions of an Array. More...
 
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 all dimensions's sizes). More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionNames (const TixiDocumentHandle handle, const char *arrayPath, char **dimensionNames)
 Retrieves the names of all dimensions. More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionValues (const TixiDocumentHandle handle, const char *arrayPath, const int dimension, double *dimensionValues)
 Retrieves the selected dimension's values (e.g. separate allowed angles etc.). More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameters (const TixiDocumentHandle handle, const char *arrayPath, int *parameters)
 Retrieves the number of parameters of an array. More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameterNames (const TixiDocumentHandle handle, const char *arrayPath, char **parameterNames)
 Retrieves names of all parameters. More...
 
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. More...
 
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. More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementCount (const TixiDocumentHandle handle, const char *arrayPath, const char *elementName, int *elements)
 Helper function. More...
 
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementNames (const TixiDocumentHandle handle, const char *arrayPath, const char *elementType, char **elementNames)
 Helper function. More...
 
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. More...
 
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. More...
 
DLL_EXPORT ReturnCode tixiCheckAttribute (TixiDocumentHandle handle, const char *elementPath, const char *attributeName)
 Checks the existence of an element's attribute. More...
 

Detailed Description

These functions operate on more complex data structures than the elementary get/add function so.

Function Documentation

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.

Adds a list of elements with the same name containd in an element with the name listName to the element specified by parentPath.

Fortran syntax:

tixi_add_double_list_with_attributes( integer handle, character*n parent_path, character*n list_name, character*n child_name, character*n child_attribute_name, real values, character*n format, character*n attributes, integer n_values, integer error )

Parameters
[in]handlefile handle as returned by tixiCreateDocument
[in]parentPathan XPath compliant path to an element in the document specified by handle (see section XPath Examples above).
[in]listNamename of the element containing the list
[in]childNamename of the child elements of the element listName
[in]childAttributeNamename of the attribute to be assigned to each child
[in]valuesarray of double holding the element values to be added ("text" content between the tags)
[in]formatformat string used to convert number into a string. The format string usage is identical to format strings in printf. If format is NULL "%g" will be used to format the string.
[in]attributesarray of pointers to strings holding the attribute values (vs. attribute name which is the same for each list entry)
[in]nValuesnumber of values in the list
Returns
  • SUCCESS if the list has been added successfully
  • FAILED if an internal error occured
  • INVALID_HANDLE if the handle is not valid, i.e. does not or no longer exist
  • INVALID_XPATH if parentPath is not a well-formed XPath-expression
  • ELEMENT_NOT_FOUND if parentPath does not point to a node in the XML-document
  • ELEMENT_PATH_NOT_UNIQUE if parentPath resolves not to a single element
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.

An element with the following structure is added:

  <x> </x>
  <y> </y>
  <z> </z>

Fortran syntax:

tixi_add_point( integer handle, character*n pointParentPath, real x, real y, real z, character*n format, integer error )

Parameters
[in]handleas returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]pointParentPathan XPath compliant path to an element into which the point elements are to be inserted in the document specified by handle (see section XPath Examples).
[in]xx coordinate of the point
[in]yy coordinate of the point
[in]zz coordinate of the point
[in]formatformat string used to convert number into a string. The format string usage is identical to format strings in printf. If format is NULL "%g" will be used to format the string.
Returns
  • SUCCESS if successfully added the point element
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if pointParentPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if pointParentPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if pointParentPath points to a non-existing element
  • ALREADY_SAVED if element should be added to an already saved document
DLL_EXPORT ReturnCode tixiCheckAttribute ( TixiDocumentHandle  handle,
const char *  elementPath,
const char *  attributeName 
)

Checks the existence of an element's attribute.

Fortran syntax:

tixi_check_attribute( integer handle, character*n element_path, character*n attribute_name, integer error )

Parameters
[in]handlehandle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]elementPathan XPath compliant path to an element in the document specified by handle (see section XPath Examples above).
[in]attributeNamename of the attribute to be added to the element
Returns
  • SUCCESS if successfully retrieve the text content of a single element
  • INVALID_HANDLE if the handle is not valid, i.e. does not or no longer exist
  • INVALID_XPATH if elementPath is not a well-formed XPath-expression
  • ATTRIBUTE_NOT_FOUND if the element has no attribute attributeName
  • ELEMENT_NOT_FOUND if elementPath does not point to a node in the XML-document
  • ELEMENT_PATH_NOT_UNIQUE if elementPath resolves not to a single element but to a list of elements
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: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array ( integer handle, character*n arrayPath, character*n element, double *values)

Parameters
[in]handlefile handle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]arrayPathan XPath compliant path to an element holding the sub-tags of the array definition in the document specified by handle (see section XPath Examples).
[in]elementNamename of the sub tag that contains the array
[in]arraySizeTotal size of the array. Size must be determined by calling tixiGetArrayDimensionSizes and must equal the product of all dimensions' sizes
[out]valuesPointer to a double array, containg all values for this dimension. The array is allocated and freed by tixi. The size of the array corresponds to the parameter arraySize
Returns
  • SUCCESS if successfully read the matrix element
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ATTRIBUTE_NOT_FOUND if the given sub element has not mapType="array"
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
  • NON_MATCHING_SIZE if arraySize does not match number of read elements in specified array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionNames ( const TixiDocumentHandle  handle,
const char *  arrayPath,
char **  dimensionNames 
)

Retrieves the names of all dimensions.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_dimension_names ( integer handle, character*n arrayPath, char*n*m dimensionNames)

Parameters
[in]handlefile handle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]arrayPathan XPath compliant path to an element holding the sub-tags of the array definition in the document specified by handle (see section XPath Examples).
[out]dimensionNamesarray of strings
Returns
  • SUCCESS if successfully read the matrix element
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensions ( const TixiDocumentHandle  handle,
const char *  arrayPath,
int *  dimensions 
)

Retrieves the number of dimensions of an Array.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

Returns the number of separate dimensions defined in sub-tags of the array in CPACS. For each dimension there is a finite set of allowed values that can be retrieved by "tixiGetArrayValues".

Example:

1 <aeroPerformanceMap>
2  <machNumber mapType="vector">0.2;0.6</machNumber>
3  <reynoldsNumber mapType="vector">10000000;30000000</reynoldsNumber>
4  <angleOfYaw mapType="vector">-5.;0;15</angleOfYaw>
5  <angleOfAttack mapType="vector">-4.;-2.;0.;2.;4.;6.;8.;10.;12.;14.;16.</angleOfAttack>
6  <cfx mapType="array">...</array>
7  <cfy mapType="array">...</array>
8  <cfz mapType="array"/>
9  <cmx mapType="array"/>
10  <cmy mapType="array"/>
11  <cmz mapType="array"/>
12 </aeroPerformanceMap>

This is a typical array definition, to be found under, e.g., the xpath "//aeroPerformanceMap":

  • All direct child tags with the attribute 'mapType="vector"' define one dimension each, containing several ";" separated values.
  • All direct child tags with the attribute 'mapType="array"' define a list of values, the list having a size of the cross product of all dimensions' sizes (in this example 2*2*3*11 = 132 elements per "array" list).

Fortran syntax:

tixi_get_array_dimensions( integer handle, character*n arrayPath, integer* dimensions )

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath-compliant path to an element holding the sub elements that define the dimensions in the document specified by the handle (see section XPath Examples).
[out]dimensionsnumber of array dimensions
Returns
  • SUCCESS if the dimensions have been successfully read
  • FAILED for internal errors
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if arrayPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if arrayPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if the rrayPath points to a element that is no array
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 all dimensions's sizes).

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_dimension_sizes ( integer handle, character*n arrayPath, int*n sizes, int* arraySizes )

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath-compliant path to the top XML element holding the sub-tags of the array definition in the document specified by the handle (see section XPath Examples).
[out]sizesan integer array containing the size of each dimension
[out]linearArraySizeproduct over all sizes (for complete array size)
Returns
  • SUCCESS if the dimensions have been successfully read
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if the arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayDimensionValues ( const TixiDocumentHandle  handle,
const char *  arrayPath,
const int  dimension,
double *  dimensionValues 
)

Retrieves the selected dimension's values (e.g. separate allowed angles etc.).

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_dimension_values ( integer handle, character*n arrayPath, int* dimension, double *dimensionValues)

Parameters
[in]handlefile handle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]arrayPathan XPath compliant path to an element holding the sub-tags of the array definition in the document specified by handle (see section XPath Examples).
[in]dimensionwhich dimension to return meaning values for
[out]dimensionValuesall values for this dimension. The return array's Size should be determined by a prior call to tixiGetArrayDimensionSizes()
Returns
  • SUCCESS if successfully read the matrix element
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementCount ( const TixiDocumentHandle  handle,
const char *  arrayPath,
const char *  elementName,
int *  elements 
)

Helper function.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

Returns the number of sub elements in CPACS arrays (either vector or array type).

For an array use example, please check tixiGetArrayDimensions(). The result for elementName="angleOfAttack" would be 11.

Fortran syntax:

tixi_get_array_element_count( integer handle, character*n arrayPath, character*n elementName, integer* elements )

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath compliant path to an element holding the sub elements that define the dimensions in the document specified by handle (see section XPath Examples).
[in]elementNameThe name of the sub element under the given xpath.
[out]elementsnumber of array parameters (separated by ";")
Returns
  • SUCCESS if successfully read the dimensions
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if arrayPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if arrayPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayElementNames ( const TixiDocumentHandle  handle,
const char *  arrayPath,
const char *  elementType,
char **  elementNames 
)

Helper function.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

Returns the tag names of sub elements of mapType given.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_element_names( integer handle, character*n arrayPath, character*n elementName, character*n*m elementNames)

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath compliant path to an element holding the sub elements that define the dimensions in the document specified by handle (see section XPath Examples).
[in]elementTypemapType to get names for (either "vector" for a dimension or "array" for the data field)
[out]elementNamesstring names of all tags found for the given type.
Returns
  • SUCCESS if successfully read the dimensions
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if arrayPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if arrayPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameterNames ( const TixiDocumentHandle  handle,
const char *  arrayPath,
char **  parameterNames 
)

Retrieves names of all parameters.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_parameter_names ( integer handle, character*n arrayPath, character*n*m parameterNames)

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath compliant path to an element holding the sub-tags of the array definition in the document specified by handle (see section XPath Examples).
[out]parameterNamesstring array containing names of each parameter
Returns
  • SUCCESS if successfully read the matrix element
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
DEPRECATED DLL_EXPORT ReturnCode tixiGetArrayParameters ( const TixiDocumentHandle  handle,
const char *  arrayPath,
int *  parameters 
)

Retrieves the number of parameters of an array.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Returns the number of different parameters (cutting all dimensions) defined in sub-tags in CPACS. Parameters are the tags with the attribute 'mapType="array"'.

Fortran syntax:

tixi_get_array_parameters( integer handle, character*n arrayPath, integer* parameters )

Parameters
[in]handleas returned by tixiCreateDocument
[in]arrayPathan XPath compliant path to an element holding the sub elements that define the dimensions in the document specified by handle (see section XPath Examples).
[out]parametersnumber of array parameters
Returns
  • SUCCESS if successfully read the dimensions
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if arrayPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if arrayPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array
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.

DEPRECATED: This is a CPACS specific function, that is no longer needed in CPACS versions >= 3.

For an array use example, please check tixiGetArrayDimensions()

Fortran syntax:

tixi_get_array_value ( double*n array, integer*n dimSize, integer*n dimPos, integer *dims)

Parameters
[in]arraythe array as returned by tixiGetArray()
[in]dimSizethe array of dimensions' sizes as returned by tixiGetArrayDimensionSizes()
[in]dimPosthe index of each dimension to fetch from the array
[in]dimsthe number of dimensions of the array as returned by tixiGetArrayDimensions()
Returns
The element fetched
DLL_EXPORT ReturnCode tixiGetFloatVector ( const TixiDocumentHandle  handle,
const char *  vectorPath,
double **  vectorArray,
const int  eNumber 
)

Retrieves a vector.

A vector is read and its contents are stored into an 1D-array. The memory necessary for the array is automatically allocated. The number of elements in the vector could be read via a call to "tixiGetVectorSize".

tixi_get_float_vector( integer handle, character*n vectorPath, real array, integer eNumber)

Parameters
[in]handlefile handle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]vectorPathan XPath compliant path to an element holding the vector in the document specified by handle (see section XPath Examples).
[out]vectorArraya pointer address for an array that should hold the vector elements
[in]eNumbermaximal number of elements that shout be read from this vector.
Returns
  • SUCCESS if successfully read the vector
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if vectorPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if vectorPath points to a non-existing 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.

An element with the following structure is expected as child of the element specified by pointParentPath

  <x> </x>
  <y> </y>
  <z> </z>

Reads a point element.

An element with the following structure is expected as child of the element specified by pointParentPath. Some or even all coordinate entries may be missing. The value of a missing coordiante is unchanged on output. This feature can be used to provide default values for non existing coordinate elements.

The coordinates are returned in the x, y, and z arguments.

Fortran syntax:

tixi_get_point( integer handle, character*n pointParentPath, integer index, real x, real y, real z, integer error )

Parameters
[in]handleas returned by tixiOpenDocument
[in]pointParentPathan XPath compliant path to an element containing point elements in the document specified by handle (see section XPath Examples).
[out]xx coordinate of the point
[out]yy coordinate of the point
[out]zz coordinate of the point
Returns
  • SUCCESS if the content of the point element is retrieved successfully
  • INVALID_HANDLE if the handle is not valid, i.e. does not or no longer exist
  • INVALID_XPATH if pointParentPath is not a well-formed XPath-expression
  • ELEMENT_NOT_FOUND if pointParentPath does not point to a node in the XML-document
  • ELEMENT_PATH_NOT_UNIQUE if pointParentPath resolves not to a single element but to a list of elements
DLL_EXPORT ReturnCode tixiGetVectorSize ( const TixiDocumentHandle  handle,
const char *  vectorPath,
int *  nElements 
)

Retrieves the size of an Vector.

Returns the size of semicolon separated elementf in an vector. The node containung the vector has to be tagged via the xml attribute <<mapType="vector">>.

tixi_get_vector_size( integer handle, character*n vectorPath, integer nElements, integer error)

Parameters
[in]handlefile handle as returned by tixiOpenDocument, tixiOpenDocumentRecursive, tixiOpenDocumentFromHTTP, tixiCreateDocument or tixiImportFromString
[in]vectorPathan XPath compliant path to an element holding the vector in the document specified by handle (see section XPath Examples).
[out]nElementsnumber of vector elements
Returns
  • SUCCESS if successfully read the matrix element
  • FAILED internal error
  • INVALID_HANDLE if the handle is not valid
  • INVALID_XPATH if matrixPath is not a well-formed XPath-expression
  • ELEMENT_PATH_NOT_UNIQUE if matrixPath resolves not to a single element but to a list of elements
  • ELEMENT_NOT_FOUND if arrayPath points to a element that is no array

Generated Tue Mar 8 2022 14:11:54, by Martin Siggel DLR