Skip to content

wkcuber.vendor.dm4

Created on Aug 7, 2015 @author: James Anderson From: https://github.com/jamesra/dm4reader/blob/master/dm4reader/__init__.py

# &nbsp class DM4Header(builtins.tuple):

DM4Header(version, root_length, little_endian)

# &nbsp DM4Header(version, root_length, little_endian)

Create new instance of DM4Header(version, root_length, little_endian)

# &nbsp version

Alias for field number 0

# &nbsp root_length

Alias for field number 1

# &nbsp little_endian

Alias for field number 2

Inherited Members
builtins.tuple
index
count
# &nbsp class DM4TagHeader(builtins.tuple):

DM4TagHeader(type, name, byte_length, array_length, data_type_code, header_offset, data_offset)

# &nbsp DM4TagHeader( type, name, byte_length, array_length, data_type_code, header_offset, data_offset )

Create new instance of DM4TagHeader(type, name, byte_length, array_length, data_type_code, header_offset, data_offset)

# &nbsp type

Alias for field number 0

# &nbsp name

Alias for field number 1

# &nbsp byte_length

Alias for field number 2

# &nbsp array_length

Alias for field number 3

# &nbsp data_type_code

Alias for field number 4

# &nbsp header_offset

Alias for field number 5

# &nbsp data_offset

Alias for field number 6

Inherited Members
builtins.tuple
index
count
# &nbsp class DM4DirHeader(builtins.tuple):

DM4DirHeader(type, name, byte_length, sorted, closed, num_tags, data_offset)

# &nbsp DM4DirHeader(type, name, byte_length, sorted, closed, num_tags, data_offset)

Create new instance of DM4DirHeader(type, name, byte_length, sorted, closed, num_tags, data_offset)

# &nbsp type

Alias for field number 0

# &nbsp name

Alias for field number 1

# &nbsp byte_length

Alias for field number 2

# &nbsp sorted

Alias for field number 3

# &nbsp closed

Alias for field number 4

# &nbsp num_tags

Alias for field number 5

# &nbsp data_offset

Alias for field number 6

Inherited Members
builtins.tuple
index
count
# &nbsp class DM4Tag(builtins.tuple):

DM4Tag(name, data_type_code, data)

# &nbsp DM4Tag(name, data_type_code, data)

Create new instance of DM4Tag(name, data_type_code, data)

# &nbsp name

Alias for field number 0

# &nbsp data_type_code

Alias for field number 1

# &nbsp data

Alias for field number 2

Inherited Members
builtins.tuple
index
count
# &nbsp class DM4DataType(builtins.tuple):

DM4DataTypes(num_bytes, signed, type_format)

# &nbsp DM4DataType(num_bytes, signed, type_format)

Create new instance of DM4DataTypes(num_bytes, signed, type_format)

# &nbsp num_bytes

Alias for field number 0

# &nbsp signed

Alias for field number 1

# &nbsp type_format

Alias for field number 2

Inherited Members
builtins.tuple
index
count
# &nbsp def tag_is_directory(tag):
# &nbsp def read_header_dm4(dmfile):
# &nbsp def read_root_tag_dir_header_dm4(dmfile, endian):

Read the root directory information from a dm4 file. File seek position is left at end of root_tag_dir_header

# &nbsp def read_tag_header_dm4(dmfile, endian):

Read the tag from the file. Leaves file at the end of the tag data, ready to read the next tag from the file

# &nbsp def read_tag_data_group(dmfile, tag, endian):
# &nbsp def read_tag_data_array(dmfile, tag, endian):
# &nbsp class DM4File:
# &nbsp DM4File(filedata)
Parameters
  • file filedata: file handle to dm4 file
# &nbsp endian_str
# &nbsp hfile
# &nbsp def close(self):
# &nbsp
@classmethod
def open(cls, filename):
Parameters
  • str filename: Name of DM4 file to open
Returns

DM4File object

# &nbsp def read_tag_data(self, tag):

Read the data associated with the passed tag

# &nbsp def read_directory(self, directory_tag=None):

Read the directories and tags from a dm4 file. The first step in working with a dm4 file.

Returns

A named collection containing information about the directory

# &nbsp class DM4File.DM4TagDir(builtins.tuple):

DM4Dir(name, dm4_tag, named_subdirs, unnamed_subdirs, named_tags, unnamed_tags)

Inherited Members
builtins.tuple
index
count