cancel checkInvariant close dump elementNameParse extensionsAdd extensionsCount extensionsLookupPrefix extensionsLookupUri extensionsPrefix extensionsUri fileName ImageFile isElementNameExtended isOpen isWritable operator!= operator== readerCount root writerCount

ImageFile ( const ustring &  fname, const ustring &  mode, const ustring &  configuration = ""  ) Open an ASTM E57 imaging data file for reading/writing. Parameters: [in] fname File name to open. Support of '\' as a directory separating character is system dependent. For maximum portability, it is recommended that '/' be used as a directory separator in file names. Special device file name support are implementation dependent (e.g. "\\.\PhysicalDrive3" or "/dev/hd3"). It is recommended that files that meet all of the requirements for a legal ASTM E57 file format use the extension ".e57". It is recommended that files that utilize the low-level E57 element data types, but do not have all the required element names required by ASTM E57 file format standard use the file extension "._e57". [in] mode Either "w" for writing or "r" for reading. [in] configuration A string that modifies the configuration of the E57 API implementation at run-time. Currently, in the reference implementation, this parameter is ignored. Write Mode In write mode, the file cannot be already open. A file with name given by fname is immediately created on the disk. This file may grow as a result of operations on the ImageFile. Which API functions write data to the file are implementation dependent. Thus any API operation that stores data may fail as a result of insufficient free disk space. Read API operations are legal for an ImageFile opened in write mode. Read Mode Read mode files may be shared. Write API operations are not legal for an ImageFile opened in read mode (i.e. the ImageFile is read-only). There is no API support for appending data onto an existing E57 data file. Postcondition: Resulting ImageFile is in open state if constructor succeeds (no exception thrown). Returns: A smart ImageFile handle referencing the underlying object. Exceptions: E57_ERROR_BAD_API_ARGUMENT E57_ERROR_OPEN_FAILED E57_ERROR_LSEEK_FAILED E57_ERROR_READ_FAILED E57_ERROR_WRITE_FAILED E57_ERROR_BAD_CHECKSUM E57_ERROR_BAD_FILE_SIGNATURE E57_ERROR_UNKNOWN_FILE_VERSION E57_ERROR_BAD_FILE_LENGTH E57_ERROR_XML_PARSER_INIT E57_ERROR_XML_PARSER E57_ERROR_BAD_XML_FORMAT E57_ERROR_BAD_CONFIGURATION E57_ERROR_INTERNAL All objects in undocumented state See also: HelloWorld.cpp example, IntegerNode, ScaledIntegerNode, FloatNode, StringNode, BlobNode, StructureNode, VectorNode, CompressedVectorNode, E57Exception, E57Utilities::E57Utilities