GXUSERMETA class¶

class geosoft.gx.GXUSERMETA¶

The USERMETA class handles user style metadata tied to real
data.

compare((GXUSERMETA)arg1) → int:¶

Compare 2 USERMETA's

Parameters:	arg1 (`geosoft.gx.GXUSERMETA`) – Second UERMETA
Returns:	0 - No 1 - Yes
Return type:	int

New in version 7.0.0.

static create((GXContext)ctx, (int)arg1) → GXUSERMETA:¶

Creates an empty USERMETA object

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (int) – USERMETA_FORMAT constants Type of Meta to create
Returns:	USERMETA Object
Return type:	`geosoft.gx.GXUSERMETA`

New in version 7.0.0.

static create_s((GXContext)ctx, (str)arg1) → GXUSERMETA:¶

Create a USERMETA from a file

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – File Name
Returns:	USERMETA Object
Return type:	`geosoft.gx.GXUSERMETA`

New in version 7.0.0.

get_data_creation_date((float_ref)arg1) → None:¶

Get the Data Creation Date

Parameters:	arg1 (`geosoft.gx.float_ref`) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_data_creator((str_ref)arg1) → None:¶

Get the Data Creator

Parameters:	arg1 (`geosoft.gx.str_ref`) – DataCreator returned
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_extents2d((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4) → None:¶

Get the 2d Extents

Parameters:	arg1 (`geosoft.gx.float_ref`) – MinX arg2 (`geosoft.gx.float_ref`) – MinY arg3 (`geosoft.gx.float_ref`) – MaxX arg4 (`geosoft.gx.float_ref`) – MaxY
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_extents3d((float_ref)arg1, (float_ref)arg2, (float_ref)arg3, (float_ref)arg4, (float_ref)arg5, (float_ref)arg6) → None:¶

Get the 3d Extents

Parameters:	arg1 (`geosoft.gx.float_ref`) – MinX arg2 (`geosoft.gx.float_ref`) – MinY arg3 (`geosoft.gx.float_ref`) – MinZ arg4 (`geosoft.gx.float_ref`) – MaxX arg5 (`geosoft.gx.float_ref`) – MaxY arg6 (`geosoft.gx.float_ref`) – MaxZ
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_format((str_ref)arg1) → None:¶

Get the File Format

Parameters:	arg1 (`geosoft.gx.str_ref`) – title returned
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_ipj((GXIPJ)arg1) → None:¶

Get the IPJ

Parameters:	arg1 (`geosoft.gx.GXIPJ`) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_meta_creation_date((float_ref)arg1) → None:¶

Get the Meta Creation Date

Parameters:	arg1 (`geosoft.gx.float_ref`) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_meta_creator((str_ref)arg1) → None:¶

Get the Meta Creator

Parameters:	arg1 (`geosoft.gx.str_ref`) – MetaCreator returned
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_project((str_ref)arg1) → None:¶

Get the File Project

Parameters:	arg1 (`geosoft.gx.str_ref`) – title returned
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_title((str_ref)arg1) → None:¶

Get the Title

Parameters:	arg1 (`geosoft.gx.str_ref`) – title returned
Returns:	Nothing
Return type:	None

New in version 7.0.0.

get_xml_format((int_ref)arg1) → None:¶

Get the XML Format

Parameters:	arg1 (`geosoft.gx.int_ref`) – USERMETA_FORMAT constants
Returns:	Nothing
Return type:	None

New in version 7.0.0.

is_null() → bool¶

Check if the instance of geosoft.gx.GXUSERMETA is null (undefined)

Returns:	True if this is a null instance of `geosoft.gx.GXUSERMETA`, False otherwise.
Return type:	bool`

static null() → GXUSERMETA¶

A null (undefined) instance of geosoft.gx.GXUSERMETA

Returns:	A null `geosoft.gx.GXUSERMETA`
Return type:	`geosoft.gx.GXUSERMETA`

static save_file_lineage((GXContext)ctx, (str)arg1, (bool)arg2) → None:¶

Add lineage to XML

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – Filename of existing metadata to update arg2 (bool) – bool Output Geosoft Metadata?
Returns:	Nothing
Return type:	None

New in version 8.2.0.

serial((bool)arg1, (str)arg2) → None:¶

Serialize USERMETA to a BF.

Parameters:	arg1 (bool) – bool Output Geosoft Metadata? arg2 (str) – File name to save to
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_data_creation_date((float)arg1) → None:¶

Set the Data Creation Date

Parameters:	arg1 (float) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_data_creator((str)arg1) → None:¶

Set the Data Creator

Parameters:	arg1 (str) – DataCreator
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_extents2d((float)arg1, (float)arg2, (float)arg3, (float)arg4) → None:¶

Set the 2d Extents

Parameters:	arg1 (float) – MinX arg2 (float) – MinY arg3 (float) – MaxX arg4 (float) – MaxY
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_extents3d((float)arg1, (float)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:¶

Set the 3d Extents

Parameters:	arg1 (float) – MinX arg2 (float) – MinY arg3 (float) – MinZ arg4 (float) – MaxX arg5 (float) – MaxY arg6 (float) – MaxZ
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_format((str)arg1) → None:¶

Set the File Format

Parameters:	arg1 (str) – Format
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_ipj((GXIPJ)arg1) → None:¶

Set the IPJ

Parameters:	arg1 (`geosoft.gx.GXIPJ`) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_meta_creation_date((float)arg1) → None:¶

Set the Meta Creation Date

Parameters:	arg1 (float) – Date
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_meta_creator((str)arg1) → None:¶

Set the Meta Creator

Parameters:	arg1 (str) – MetaCreator
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_project((str)arg1) → None:¶

Set the File Project

Parameters:	arg1 (str) – Project
Returns:	Nothing
Return type:	None

New in version 7.0.0.

set_title((str)arg1) → None:¶

Set the Title

Parameters:	arg1 (str) – Title
Returns:	Nothing
Return type:	None

New in version 7.0.0.

static update_extents2_d((GXContext)ctx, (str)arg1, (GXIPJ)arg2, (float)arg3, (float)arg4, (float)arg5, (float)arg6) → None:¶

Edit an existing XML metadata file by
changing the extents and projection data

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – Filename of existing metadata to update arg2 (`geosoft.gx.GXIPJ`) – New projection arg3 (float) – New MinX value arg4 (float) – New MinY value arg5 (float) – New MaxX value arg6 (float) – New MaxY value
Returns:	Nothing
Return type:	None

New in version 7.0.1.

static update_file_type((GXContext)ctx, (str)arg1, (str)arg2) → None:¶

Edit an existing XML metadata file by
changing the file type

Parameters:	ctx (`geosoft.gx.GXContext`) – The GX execution context arg1 (str) – Filename of existing metadata to update arg2 (str) – New file type
Returns:	Nothing
Return type:	None

New in version 7.2.0.

USERMETA_FORMAT constants¶

USERMETA Format Types

gx.USERMETA_FORMAT_DEFAULT = -1¶

Use the standard type for the system

gx.USERMETA_FORMAT_ISO = 0¶

ISO 19139 standard

gx.USERMETA_FORMAT_FGDC = 1¶

FGDC Metadata Standard

GXUSERMETA class¶

USERMETA_FORMAT constants¶

Table Of Contents

This Page