e57 Namespace Reference
Namespaces | |
| namespace | Utilities |
Classes | |
| class | BitpackDecoder |
| class | BitpackEncoder |
| class | BitpackFloatDecoder |
| class | BitpackFloatEncoder |
| class | BitpackIntegerDecoder |
| class | BitpackIntegerEncoder |
| class | BitpackStringDecoder |
| class | BitpackStringEncoder |
| class | BlobNode |
| class | BlobNodeImpl |
| struct | BlobSectionHeader |
| class | BufferView |
| Tool class to read buffer efficiently without multiplying copy operations. More... | |
| struct | CartesianBounds |
| Specifies an axis-aligned box in local cartesian coordinates. More... | |
| class | CheckedFile |
| struct | ColorLimits |
| Specifies the limits for the value of red, green, and blue color that a sensor is capable of producing. More... | |
| class | CompressedVectorNode |
| class | CompressedVectorNodeImpl |
| class | CompressedVectorReader |
| class | CompressedVectorReaderImpl |
| struct | CompressedVectorSectionHeader |
| class | CompressedVectorWriter |
| class | CompressedVectorWriterImpl |
| class | ConstantIntegerDecoder |
| class | ConstantIntegerEncoder |
| struct | CylindricalRepresentation |
| Stores an image that is mapped from 3D using a cylindrical projection model. More... | |
| struct | Data3D |
| Stores the top-level information for a single lidar scan. More... | |
| struct | Data3DPointsData_t |
| Stores pointers to user-provided buffers. More... | |
| class | DataPacket |
| class | DataPacketHeader |
| struct | DateTime |
| Encodes date and time. More... | |
| struct | DecodeChannel |
| class | Decoder |
| class | E57Exception |
| Object thrown by E57 API functions to communicate the conditions of an error. More... | |
| struct | E57FileHeader |
| struct | E57Root |
| Stores the top-level information for the XML section of the file. More... | |
| class | E57XmlFileInputSource |
| class | E57XmlParser |
| class | Encoder |
| class | FloatNode |
| class | FloatNodeImpl |
| struct | GroupingByLine |
| Stores a set of point groups organized by the rowIndex or columnIndex attribute of the PointRecord. More... | |
| struct | Image2D |
| Stores an image from a camera. More... | |
| class | ImageFile |
| class | ImageFileImpl |
| struct | IndexBounds |
| Stores the minimum and maximum of rowIndex, columnIndex, and returnIndex fields for a set of points. More... | |
| class | IntegerNode |
| class | IntegerNodeImpl |
| struct | IntensityLimits |
| Specifies the limits for the value of signal intensity that a sensor is capable of producing. More... | |
| struct | LineGroupRecord |
| Stores information about a single group of points in a row or column. More... | |
| struct | NameSpace |
| class | Node |
| class | NodeImpl |
| class | PacketLock |
| class | PacketReadCache |
| struct | PinholeRepresentation |
| Stores an image that is mapped from 3D using the pinhole camera projection model. More... | |
| struct | PointGroupingSchemes |
| Supports the division of points within an Data3D into logical groupings. More... | |
| struct | PointStandardizedFieldsAvailable |
| Used to interrogate if standardized fields are available. More... | |
| struct | Quaternion |
| Represents a rigid body rotation. More... | |
| class | Reader |
| Used for reading of the E57 file with E57 Simple API. More... | |
| class | ReaderImpl |
| most of the functions follows Reader More... | |
| struct | RigidBodyTransform |
| Defines a rigid body transform in cartesian coordinates. More... | |
| class | ScaledIntegerNode |
| class | ScaledIntegerNodeImpl |
| struct | SortByBytestreamNumber |
| class | SourceDestBuffer |
| class | SourceDestBufferImpl |
| struct | SphericalBounds |
| Stores the bounds of some data in spherical coordinates. More... | |
| struct | SphericalRepresentation |
| Stores an image that is mapped from 3D using a spherical projection model. More... | |
| class | StringNode |
| class | StringNodeImpl |
| class | StructureNode |
| class | StructureNodeImpl |
| struct | Translation |
| Defines a rigid body translation in Cartesian coordinates. More... | |
| class | VectorNode |
| class | VectorNodeImpl |
| struct | VisualReferenceRepresentation |
| Stores an image that is to be used only as a visual reference. More... | |
| class | Writer |
| Used for writing of the E57 file with E57 Simple API. More... | |
| class | WriterImpl |
| most of the functions follows Writer More... | |
Typedefs | |
| typedef Data3DPointsData_t< float > | Data3DPointsData |
| typedef Data3DPointsData_t< double > | Data3DPointsData_d |
| using | ImageFileImplSharedPtr = std::shared_ptr< class ImageFileImpl > |
| using | ImageFileImplWeakPtr = std::weak_ptr< class ImageFileImpl > |
| using | NodeImplSharedPtr = std::shared_ptr< class NodeImpl > |
| using | NodeImplWeakPtr = std::weak_ptr< class NodeImpl > |
| using | ReadChecksumPolicy = int |
| Specifies the percentage of checksums which are verified when reading an ImageFile (0-100%). More... | |
| using | StringList = std::vector< std::string > |
| using | StringSet = std::set< std::string > |
| using | ustring = std::string |
| UTF-8 encodeded Unicode string. More... | |
Functions | |
| std::string | binaryString (int16_t x) |
| std::string | binaryString (int32_t x) |
| std::string | binaryString (int64_t x) |
| std::string | binaryString (int8_t x) |
| std::string | binaryString (uint16_t x) |
| std::string | binaryString (uint32_t x) |
| std::string | binaryString (uint64_t x) |
| std::string | binaryString (uint8_t x) |
| std::string | generateRandomGUID () |
| generates a new random GUID More... | |
| std::string | hexString (int16_t x) |
| std::string | hexString (int32_t x) |
| std::string | hexString (int64_t x) |
| std::string | hexString (int8_t x) |
| std::string | hexString (uint16_t x) |
| std::string | hexString (uint32_t x) |
| std::string | hexString (uint64_t x) |
| std::string | hexString (uint8_t x) |
| std::string | space (size_t n) |
| Create whitespace of given length, for indenting printouts in dump() functions. More... | |
| template<class T > | |
| std::string | toString (T x) |
| Convert number to decimal, hexadecimal, and binary strings (Note hex strings don't have leading zeros). More... | |
Variables | |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_ALL = 100 |
| Verify all checksums. This is the default. (slow) More... | |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_HALF = 50 |
| Only verify 50% of the checksums. The last block is always verified. More... | |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_NONE = 0 |
| Do not verify the checksums. (fast) More... | |
| constexpr ReadChecksumPolicy | CHECKSUM_POLICY_SPARSE = 25 |
| Only verify 25% of the checksums. The last block is always verified. More... | |
| constexpr int | DATA_PACKET_MAX = ( 64 * 1024 ) |
| maximum size of CompressedVector binary data packet More... | |
| constexpr uint32_t | E57_FORMAT_MAJOR = 1 |
| Version numbers of ASTM standard that this library supports. More... | |
| constexpr uint32_t | E57_FORMAT_MINOR = 0 |
| constexpr double | E57_NOT_SCALED_USE_FLOAT = 0. |
| Indicates to use FloatNode instead of ScaledIntegerNode in fields that can use both. More... | |
| constexpr double | E57_NOT_SCALED_USE_INTEGER = -1. |
| Indicates to use ScaledIntegerNode instead of FloatNode in fields that can use both. More... | |
| constexpr char | E57_V1_0_URI [] = "http://www.astm.org/COMMIT/E57/2010-e57-v1.0" |
| The URI of ASTM E57 v1.0 standard XML namespace Note that even though this URI does not point to a valid document, the standard (section 8.4.2.3) says that this is the required namespace. More... | |
Typedef Documentation
◆ Data3DPointsData
| typedef Data3DPointsData_t<float> e57::Data3DPointsData |
◆ Data3DPointsData_d
| typedef Data3DPointsData_t<double> e57::Data3DPointsData_d |
◆ ImageFileImplSharedPtr
| using e57::ImageFileImplSharedPtr = typedef std::shared_ptr<class ImageFileImpl> |
◆ ImageFileImplWeakPtr
| using e57::ImageFileImplWeakPtr = typedef std::weak_ptr<class ImageFileImpl> |
◆ NodeImplSharedPtr
| using e57::NodeImplSharedPtr = typedef std::shared_ptr<class NodeImpl> |
◆ NodeImplWeakPtr
| using e57::NodeImplWeakPtr = typedef std::weak_ptr<class NodeImpl> |
◆ ReadChecksumPolicy
| using e57::ReadChecksumPolicy = typedef int |
Specifies the percentage of checksums which are verified when reading an ImageFile (0-100%).
◆ StringList
| using e57::StringList = typedef std::vector<std::string> |
◆ StringSet
| using e57::StringSet = typedef std::set<std::string> |
◆ ustring
| using e57::ustring = typedef std::string |
UTF-8 encodeded Unicode string.
Enumeration Type Documentation
◆ anonymous enum
| anonymous enum |
◆ anonymous enum
◆ ErrorCode
| enum e57::ErrorCode |
Numeric error identifiers used in E57Exception.
| Enumerator | |
|---|---|
| E57_SUCCESS | operation was successful |
| E57_ERROR_BAD_CV_HEADER | a CompressedVector binary header was bad |
| E57_ERROR_BAD_CV_PACKET | a CompressedVector binary packet was bad |
| E57_ERROR_CHILD_INDEX_OUT_OF_BOUNDS | a numerical index identifying a child was out of bounds |
| E57_ERROR_SET_TWICE | attempted to set an existing child element to a new value |
| E57_ERROR_HOMOGENEOUS_VIOLATION | attempted to add an E57 Element that would have made the children of a homogeneous Vector have different types |
| E57_ERROR_VALUE_NOT_REPRESENTABLE | a value could not be represented in the requested type |
| E57_ERROR_SCALED_VALUE_NOT_REPRESENTABLE | after scaling the result could not be represented in the requested type |
| E57_ERROR_REAL64_TOO_LARGE | a 64 bit IEEE float was too large to store in a 32 bit IEEE float |
| E57_ERROR_EXPECTING_NUMERIC | Expecting numeric representation in user's buffer, found ustring. |
| E57_ERROR_EXPECTING_USTRING | Expecting string representation in user's buffer, found numeric. |
| E57_ERROR_INTERNAL | An unrecoverable inconsistent internal state was detected. |
| E57_ERROR_BAD_XML_FORMAT | E57 primitive not encoded in XML correctly. |
| E57_ERROR_XML_PARSER | XML not well formed. |
| E57_ERROR_BAD_API_ARGUMENT | bad API function argument provided by user |
| E57_ERROR_FILE_IS_READ_ONLY | can't modify read only file |
| E57_ERROR_BAD_CHECKSUM | checksum mismatch, file is corrupted |
| E57_ERROR_OPEN_FAILED | open() failed |
| E57_ERROR_CLOSE_FAILED | close() failed |
| E57_ERROR_READ_FAILED | read() failed |
| E57_ERROR_WRITE_FAILED | write() failed |
| E57_ERROR_LSEEK_FAILED | lseek() failed |
| E57_ERROR_PATH_UNDEFINED | E57 element path well formed but not defined. |
| E57_ERROR_BAD_BUFFER | bad SourceDestBuffer |
| E57_ERROR_NO_BUFFER_FOR_ELEMENT | no buffer specified for an element in CompressedVectorNode during write |
| E57_ERROR_BUFFER_SIZE_MISMATCH | SourceDestBuffers not all same size. |
| E57_ERROR_BUFFER_DUPLICATE_PATHNAME | duplicate pathname in CompressedVectorNode read/write |
| E57_ERROR_BAD_FILE_SIGNATURE | file signature not "ASTM-E57" |
| E57_ERROR_UNKNOWN_FILE_VERSION | incompatible file version |
| E57_ERROR_BAD_FILE_LENGTH | size in file header not same as actual |
| E57_ERROR_XML_PARSER_INIT | XML parser failed to initialize. |
| E57_ERROR_DUPLICATE_NAMESPACE_PREFIX | namespace prefix already defined |
| E57_ERROR_DUPLICATE_NAMESPACE_URI | namespace URI already defined |
| E57_ERROR_BAD_PROTOTYPE | bad prototype in CompressedVectorNode |
| E57_ERROR_BAD_CODECS | bad codecs in CompressedVectorNode |
| E57_ERROR_VALUE_OUT_OF_BOUNDS | element value out of min/max bounds |
| E57_ERROR_CONVERSION_REQUIRED | conversion required to assign element value, but not requested |
| E57_ERROR_BAD_PATH_NAME | E57 path name is not well formed. |
| E57_ERROR_NOT_IMPLEMENTED | functionality not implemented |
| E57_ERROR_BAD_NODE_DOWNCAST | bad downcast from Node to specific node type |
| E57_ERROR_WRITER_NOT_OPEN | CompressedVectorWriter is no longer open. |
| E57_ERROR_READER_NOT_OPEN | CompressedVectorReader is no longer open. |
| E57_ERROR_NODE_UNATTACHED | node is not yet attached to tree of ImageFile |
| E57_ERROR_ALREADY_HAS_PARENT | node already has a parent |
| E57_ERROR_DIFFERENT_DEST_IMAGEFILE | nodes were constructed with different destImageFiles |
| E57_ERROR_IMAGEFILE_NOT_OPEN | destImageFile is no longer open |
| E57_ERROR_BUFFERS_NOT_COMPATIBLE | SourceDestBuffers not compatible with previously given ones. |
| E57_ERROR_TOO_MANY_WRITERS | too many open CompressedVectorWriters of an ImageFile |
| E57_ERROR_TOO_MANY_READERS | too many open CompressedVectorReaders of an ImageFile |
| E57_ERROR_BAD_CONFIGURATION | bad configuration string |
| E57_ERROR_INVARIANCE_VIOLATION | class invariance constraint violation in debug mode |
◆ FloatPrecision
| enum e57::FloatPrecision |
◆ Image2DProjection
Identifies the representation for the image data.
| Enumerator | |
|---|---|
| E57_NO_PROJECTION | No representation for the image data is present. |
| E57_VISUAL | VisualReferenceRepresentation for the image data. |
| E57_PINHOLE | PinholeRepresentation for the image data. |
| E57_SPHERICAL | SphericalRepresentation for the image data. |
| E57_CYLINDRICAL | CylindricalRepresentation for the image data. |
◆ Image2DType
| enum e57::Image2DType |
◆ MemoryRepresentation
Identifies the representations of memory elements API can transfer data to/from.
◆ NodeType
| enum e57::NodeType |
Identifiers for types of E57 elements.
| Enumerator | |
|---|---|
| E57_STRUCTURE | StructureNode class. |
| E57_VECTOR | VectorNode class. |
| E57_COMPRESSED_VECTOR | CompressedVectorNode class. |
| E57_INTEGER | IntegerNode class. |
| E57_SCALED_INTEGER | ScaledIntegerNode class. |
| E57_FLOAT | FloatNode class. |
| E57_STRING | StringNode class. |
| E57_BLOB | BlobNode class. |
Function Documentation
◆ binaryString() [1/8]
| std::string e57::binaryString | ( | int16_t | x | ) |
References binaryString().
◆ binaryString() [2/8]
| std::string e57::binaryString | ( | int32_t | x | ) |
References binaryString().
◆ binaryString() [3/8]
| std::string e57::binaryString | ( | int64_t | x | ) |
References binaryString().
◆ binaryString() [4/8]
| std::string e57::binaryString | ( | int8_t | x | ) |
References binaryString().
◆ binaryString() [5/8]
| std::string e57::binaryString | ( | uint16_t | x | ) |
◆ binaryString() [6/8]
| std::string e57::binaryString | ( | uint32_t | x | ) |
◆ binaryString() [7/8]
| std::string e57::binaryString | ( | uint64_t | x | ) |
◆ binaryString() [8/8]
| std::string e57::binaryString | ( | uint8_t | x | ) |
◆ generateRandomGUID()
| std::string e57::generateRandomGUID | ( | ) |
generates a new random GUID
Referenced by e57::WriterImpl::NewData3D(), e57::WriterImpl::NewImage2D(), and e57::WriterImpl::WriterImpl().
◆ hexString() [1/8]
| std::string e57::hexString | ( | int16_t | x | ) |
References hexString().
◆ hexString() [2/8]
| std::string e57::hexString | ( | int32_t | x | ) |
References hexString().
◆ hexString() [3/8]
| std::string e57::hexString | ( | int64_t | x | ) |
References hexString().
◆ hexString() [4/8]
| std::string e57::hexString | ( | int8_t | x | ) |
References hexString().
◆ hexString() [5/8]
| std::string e57::hexString | ( | uint16_t | x | ) |
◆ hexString() [6/8]
| std::string e57::hexString | ( | uint32_t | x | ) |
◆ hexString() [7/8]
| std::string e57::hexString | ( | uint64_t | x | ) |
Referenced by hexString(), and e57::BitpackIntegerEncoder< RegisterT >::processRecords().
◆ hexString() [8/8]
| std::string e57::hexString | ( | uint8_t | x | ) |
◆ space()
| std::string e57::space | ( | size_t | n | ) |
Create whitespace of given length, for indenting printouts in dump() functions.
Referenced by e57::BlobNodeImpl::writeXml(), e57::CompressedVectorNodeImpl::writeXml(), e57::FloatNodeImpl::writeXml(), e57::IntegerNodeImpl::writeXml(), e57::ScaledIntegerNodeImpl::writeXml(), e57::StringNodeImpl::writeXml(), e57::StructureNodeImpl::writeXml(), and e57::VectorNodeImpl::writeXml().
◆ toString()
template<class T >
| std::string e57::toString | ( | T | x | ) |
Convert number to decimal, hexadecimal, and binary strings (Note hex strings don't have leading zeros).
Referenced by e57::BlobNode::BlobNode(), e57::NodeImpl::checkBuffers(), e57::SourceDestBufferImpl::checkCompatible(), e57::CheckedFile::close(), e57::CompressedVectorNode::CompressedVectorNode(), e57::CompressedVectorReaderImpl::CompressedVectorReaderImpl(), e57::CompressedVectorWriterImpl::CompressedVectorWriterImpl(), e57::Decoder::DecoderFactory(), e57::ImageFileImpl::decrReaderCount(), e57::ImageFileImpl::decrWriterCount(), e57::BitpackDecoder::destBufferSetNew(), e57::ConstantIntegerDecoder::destBufferSetNew(), e57::Encoder::EncoderFactory(), e57::CheckedFile::extend(), e57::FloatNode::FloatNode(), e57::FloatNodeImpl::FloatNodeImpl(), e57::StructureNodeImpl::get(), e57::DataPacket::getBytestream(), e57::SourceDestBufferImpl::getNextFloat(), e57::SourceDestBufferImpl::getNextInt64(), e57::BitpackDecoder::inBufferShiftDown(), e57::BitpackDecoder::inputProcess(), e57::BitpackFloatDecoder::inputProcessAligned(), e57::BitpackStringDecoder::inputProcessAligned(), e57::BitpackIntegerDecoder< RegisterT >::inputProcessAligned(), e57::IntegerNode::IntegerNode(), e57::IntegerNodeImpl::IntegerNodeImpl(), e57::PacketReadCache::lock(), e57::BitpackEncoder::outBufferShiftDown(), e57::BitpackEncoder::outputRead(), e57::ConstantIntegerEncoder::outputRead(), e57::PacketReadCache::PacketReadCache(), e57::BitpackFloatEncoder::processRecords(), e57::BitpackStringEncoder::processRecords(), e57::BitpackIntegerEncoder< RegisterT >::processRecords(), e57::ConstantIntegerEncoder::processRecords(), e57::CompressedVectorReaderImpl::read(), e57::CheckedFile::read(), e57::BlobNodeImpl::read(), e57::CompressedVectorNodeImpl::reader(), e57::PacketReadCache::readPacket(), e57::ScaledIntegerNode::ScaledIntegerNode(), e57::ScaledIntegerNodeImpl::ScaledIntegerNodeImpl(), e57::StructureNodeImpl::set(), e57::SourceDestBufferImpl::setNextInt64(), e57::BitpackEncoder::sourceBufferSetNew(), e57::ConstantIntegerEncoder::sourceBufferSetNew(), e57::StringNode::StringNode(), e57::StructureNode::StructureNode(), e57::PacketReadCache::unlock(), e57::VectorNode::VectorNode(), e57::CompressedVectorSectionHeader::verify(), EmptyPacketHeader::verify(), e57::DataPacketHeader::verify(), e57::DataPacket::verify(), IndexPacket::verify(), e57::CompressedVectorWriterImpl::write(), e57::BlobNodeImpl::write(), and e57::CompressedVectorNodeImpl::writer().
Variable Documentation
◆ CHECKSUM_POLICY_ALL
|
constexpr |
Verify all checksums. This is the default. (slow)
Referenced by e57::CheckedFile::read().
◆ CHECKSUM_POLICY_HALF
|
constexpr |
Only verify 50% of the checksums. The last block is always verified.
◆ CHECKSUM_POLICY_NONE
|
constexpr |
Do not verify the checksums. (fast)
Referenced by e57::CheckedFile::read().
◆ CHECKSUM_POLICY_SPARSE
|
constexpr |
Only verify 25% of the checksums. The last block is always verified.
◆ DATA_PACKET_MAX
|
constexpr |
maximum size of CompressedVector binary data packet
Referenced by e57::Encoder::EncoderFactory(), e57::PacketReadCache::readPacket(), and e57::CompressedVectorWriterImpl::write().
◆ E57_FORMAT_MAJOR
|
constexpr |
Version numbers of ASTM standard that this library supports.
Referenced by e57::ImageFileImpl::close(), and e57::Utilities::getVersions().
◆ E57_FORMAT_MINOR
|
constexpr |
Referenced by e57::ImageFileImpl::close(), and e57::Utilities::getVersions().
◆ E57_NOT_SCALED_USE_FLOAT
|
constexpr |
Indicates to use FloatNode instead of ScaledIntegerNode in fields that can use both.
Referenced by e57::ReaderImpl::ReadData3D().
◆ E57_NOT_SCALED_USE_INTEGER
|
constexpr |
Indicates to use ScaledIntegerNode instead of FloatNode in fields that can use both.
Referenced by e57::ReaderImpl::ReadData3D().
◆ E57_V1_0_URI
|
constexpr |
The URI of ASTM E57 v1.0 standard XML namespace Note that even though this URI does not point to a valid document, the standard (section 8.4.2.3) says that this is the required namespace.
Referenced by e57::WriterImpl::WriterImpl(), and e57::StructureNodeImpl::writeXml().
