Enumerations

Enumerations
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 }
enum	StorageMode { ROW_WISE , COLUMN_WISE }
enum	OpenMode { OPENMODE_PLAIN , OPENMODE_RECURSIVE }
enum	AddLinkMode { ADDLINK_CREATE , ADDLINK_CREATE_AND_OPEN }
enum	MessageType { MESSAGETYPE_ERROR , MESSAGETYPE_WARNING , MESSAGETYPE_STATUS }

Detailed Description

Enumeration Type Documentation

AddLinkMode

enum AddLinkMode

Mode how to add external data nodes to the document.

Has a typedef to AddLinkMode.

Enumerator
ADDLINK_CREATE	Just create the link. The files won't be load into the document.
ADDLINK_CREATE_AND_OPEN	Creates the link and loads the specified file into the document.

Definition at line 397 of file tixi.h.

MessageType

enum MessageType

Type of a TiXI message

This is used, if the user wants to override the default message system in TiXI.

Enumerator
MESSAGETYPE_ERROR	The message is an error
MESSAGETYPE_WARNING	The message is a warning
MESSAGETYPE_STATUS	A status message

Definition at line 415 of file tixi.h.

OpenMode

enum OpenMode

Open mode of a xml file This enum indicates how a xml file is opend. If OpenMode is OPENMODE_PLAIN, the xml file is open "normal" and just the given file is opend. If OpenMode is OPENMODE_RECURSIVE, then all external files specified in a <externaldata> node are opend and replaced in the xml tree.

Has a typedef to OpenMode.

Enumerator
OPENMODE_PLAIN	Open just the xml file
OPENMODE_RECURSIVE	Open with external files

Definition at line 382 of file tixi.h.

ReturnCode

enum ReturnCode

ReturnCode return code of TIXI-routines. Has a typedef to ReturnCode.

Enumerator
SUCCESS	0: No error occurred
FAILED	1: Unspecified error
INVALID_XML_NAME	2: Non XML standard compliant name specified
NOT_WELL_FORMED	3: Document is not well formed
NOT_SCHEMA_COMPLIANT	4: Document is not schema compliant
NOT_DTD_COMPLIANT	5: Document is not DTD compliant
INVALID_HANDLE	6: Document handle is not valid
INVALID_XPATH	7: XPath expression is not valid
ELEMENT_NOT_FOUND	8: Element does not exist in document
INDEX_OUT_OF_RANGE	9: Index supplied as argument is not inside the admissible range
NO_POINT_FOUND	10: No point element found a given XPath
NOT_AN_ELEMENT	11: XPath expression does not point to an XML-element node
ATTRIBUTE_NOT_FOUND	12: Element does not have the attribute
OPEN_FAILED	13: Error on opening the file
OPEN_SCHEMA_FAILED	14: Error on opening the schema file
OPEN_DTD_FAILED	15: Error on opening the DTD file
CLOSE_FAILED	16: Error on closing the file
ALREADY_SAVED	17: Trying to modify already saved document
ELEMENT_PATH_NOT_UNIQUE	18: Path expression can not be resolved unambiguously
NO_ELEMENT_NAME	19: Element name argument is NULL
NO_CHILDREN	20: Node has no children
CHILD_NOT_FOUND	21: Named child is not child of element specified
EROROR_CREATE_ROOT_NODE	22: Error when adding root node to new document
DEALLOCATION_FAILED	23: On closing a document the deallocation of allocated memory fails
NO_NUMBER	24: No number specified
NO_ATTRIBUTE_NAME	25: No attribute name specified
STRING_TRUNCATED	26: String variable supplied is to small to hold the result, Fortran only
NON_MATCHING_NAME	27: Row or column name specified do not match the names used in the document
NON_MATCHING_SIZE	28: Number of rows or columns specified do not match the sizes of the matrix in the document
MATRIX_DIMENSION_ERROR	29: if nRows or nColumns or both are less than 1
COORDINATE_NOT_FOUND	30: missing coordinate inside a point element
UNKNOWN_STORAGE_MODE	31: storage mode specified is neither ROW_WISE nor COLUMN_WISE
UID_NOT_UNIQUE	32: One or more uID's are not unique
UID_DONT_EXISTS	33: A given uID's does not exist
UID_LINK_BROKEN	34: A node the is specified as a Link has no correspoding uid in that data set
INVALID_NAMESPACE_URI	35: The namespace URI is invalid (e.g. a null pointer)
INVALID_NAMESPACE_PREFIX	36: The namespace prefix is invalid

Definition at line 258 of file tixi.h.

StorageMode

enum StorageMode

Strorage mode of arrays This enum indicates how a matrix is stored in an array on input or should be retrieved into an array on output. If ROW_WISE is specified the order will be (1,1), (1,2), ..., (2,1), (2,2), (2,3)... If COLUMN_WISE is specified the order will be (1,1), (2,1), (3,1), .., (1,2),(2,2),(3,2) ...

Has a typedef to StorageMode.

Enumerator
ROW_WISE	row wise order
COLUMN_WISE	column wise

Definition at line 361 of file tixi.h.