resqpy.olio.vdb.KP

class resqpy.olio.vdb.KP(fp, place=4)[source]

Bases: object

Internal class for a (Key, Pointer) record in a vdb file.

Methods:

__init__(fp[, place])

Creates a new (Key, Pointer) record object.

header_place_for_key(key[, search])

Returns file position pointer for a given key.

head_for_key(key[, search])

Returns a Header record object for the given key.

data_for_key(key[, search])

Returns a Data object for the given key.

key_list([filter])

Returns a list of keys.

sub_key_list(keyword[, filter])

Returns a list of keys subordinate to keyword.


__init__(fp, place=4)[source]

Creates a new (Key, Pointer) record object.

header_place_for_key(key, search=False)[source]

Returns file position pointer for a given key.

head_for_key(key, search=False)[source]

Returns a Header record object for the given key.

data_for_key(key, search=False)[source]

Returns a Data object for the given key.

key_list(filter=False)[source]

Returns a list of keys.

sub_key_list(keyword, filter=False)[source]

Returns a list of keys subordinate to keyword.