E57 Foundation API v1.1.312  Aug. 10, 2011
Classes | Defines | Typedefs | Enumerations | Variables
C:/Projects32/e57-3d-imgfmt/trunk/include/E57Foundation.h File Reference

header file for the E57 Foundation API More...

Include dependency graph for E57Foundation.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  Node
 Generic handle to any of the 8 types of E57 element objects. More...
class  StructureNode
 An E57 element containing named child nodes. More...
class  VectorNode
 An E57 element containing ordered vector of child nodes. More...
class  SourceDestBuffer
 A memory buffer to transfer data to/from a CompressedVectorNode in a block. More...
class  CompressedVectorReader
 An iterator object keeping track of a read in progress from a CompressedVectorNode. More...
class  CompressedVectorWriter
 An iterator object keeping track of a write in progress to a CompressedVectorNode. More...
class  CompressedVectorNode
 An E57 element containing ordered vector of child nodes, stored in an efficient binary format. More...
class  IntegerNode
 An E57 element encoding an integer value. More...
class  ScaledIntegerNode
 An E57 element encoding a fixed point number. More...
class  FloatNode
 An E57 element encoding a single or double precision IEEE floating point number. More...
class  StringNode
 An E57 element encoding a Unicode character string value. More...
class  BlobNode
 An E57 element encoding an fixed-length sequence of bytes with an opaque format. More...
class  ImageFile
 An ASTM E57 3D format file object. More...
class  E57Exception
 Object thrown by E57 Foundation API functions to communicate the conditions of an error. More...
class  E57Utilities
 Utility functions not associated with any object. More...

Defines

#define E57_V1_0_URI   "http://www.astm.org/COMMIT/E57/2010-e57-v1.0"
 The URI of ASTM E57 v1.0 standard XML namespace.

Typedefs

typedef std::string ustring
 UTF-8 encodeded Unicode string.

Enumerations

enum  NodeType {
  E57_STRUCTURE = 1, E57_VECTOR = 2, E57_COMPRESSED_VECTOR = 3, E57_INTEGER = 4,
  E57_SCALED_INTEGER = 5, E57_FLOAT = 6, E57_STRING = 7, E57_BLOB = 8
}
 Identifiers for types of E57 elements. More...
enum  FloatPrecision { E57_SINGLE = 1, E57_DOUBLE = 2 }
 The IEEE floating point number precisions supported. More...
enum  MemoryRepresentation {
  E57_INT8 = 1, E57_UINT8 = 2, E57_INT16 = 3, E57_UINT16 = 4,
  E57_INT32 = 5, E57_UINT32 = 6, E57_INT64 = 7, E57_BOOL = 8,
  E57_REAL32 = 9, E57_REAL64 = 10, E57_USTRING = 11
}
 Identifies the representations of memory elements API can transfer data to/from. More...
enum  ErrorCode {
  E57_SUCCESS = 0, E57_ERROR_BAD_CV_HEADER = 1, E57_ERROR_BAD_CV_PACKET = 2, E57_ERROR_CHILD_INDEX_OUT_OF_BOUNDS = 3,
  E57_ERROR_SET_TWICE = 4, E57_ERROR_HOMOGENEOUS_VIOLATION = 5, E57_ERROR_VALUE_NOT_REPRESENTABLE = 6, E57_ERROR_SCALED_VALUE_NOT_REPRESENTABLE = 7,
  E57_ERROR_REAL64_TOO_LARGE = 8, E57_ERROR_EXPECTING_NUMERIC = 9, E57_ERROR_EXPECTING_USTRING = 10, E57_ERROR_INTERNAL = 11,
  E57_ERROR_BAD_XML_FORMAT = 12, E57_ERROR_XML_PARSER = 13, E57_ERROR_BAD_API_ARGUMENT = 14, E57_ERROR_FILE_IS_READ_ONLY = 15,
  E57_ERROR_BAD_CHECKSUM = 16, E57_ERROR_OPEN_FAILED = 17, E57_ERROR_CLOSE_FAILED = 18, E57_ERROR_READ_FAILED = 19,
  E57_ERROR_WRITE_FAILED = 20, E57_ERROR_LSEEK_FAILED = 21, E57_ERROR_PATH_UNDEFINED = 22, E57_ERROR_BAD_BUFFER = 23,
  E57_ERROR_NO_BUFFER_FOR_ELEMENT = 24, E57_ERROR_BUFFER_SIZE_MISMATCH = 25, E57_ERROR_BUFFER_DUPLICATE_PATHNAME = 26, E57_ERROR_BAD_FILE_SIGNATURE = 27,
  E57_ERROR_UNKNOWN_FILE_VERSION = 28, E57_ERROR_BAD_FILE_LENGTH = 29, E57_ERROR_XML_PARSER_INIT = 30, E57_ERROR_DUPLICATE_NAMESPACE_PREFIX = 31,
  E57_ERROR_DUPLICATE_NAMESPACE_URI = 32, E57_ERROR_BAD_PROTOTYPE = 33, E57_ERROR_BAD_CODECS = 34, E57_ERROR_VALUE_OUT_OF_BOUNDS = 35,
  E57_ERROR_CONVERSION_REQUIRED = 36, E57_ERROR_BAD_PATH_NAME = 37, E57_ERROR_NOT_IMPLEMENTED = 38, E57_ERROR_BAD_NODE_DOWNCAST = 39,
  E57_ERROR_WRITER_NOT_OPEN = 40, E57_ERROR_READER_NOT_OPEN = 41, E57_ERROR_NODE_UNATTACHED = 42, E57_ERROR_ALREADY_HAS_PARENT = 43,
  E57_ERROR_DIFFERENT_DEST_IMAGEFILE = 44, E57_ERROR_IMAGEFILE_NOT_OPEN = 45, E57_ERROR_BUFFERS_NOT_COMPATIBLE = 46, E57_ERROR_TOO_MANY_WRITERS = 47,
  E57_ERROR_TOO_MANY_READERS = 48, E57_ERROR_BAD_CONFIGURATION = 49, E57_ERROR_INVARIANCE_VIOLATION = 50
}
 Numeric error identifiers used in E57Exception. More...

Variables

const int E57_FOUNDATION_API_MAJOR = 0
 The major version number of the Foundation API.
const int E57_FOUNDATION_API_MINOR = 51
 The minor version number of the Foundation API.

Detailed Description

header file for the E57 Foundation API

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines