RVC::METADATA Class Reference

Manages RVC::OBJTYPE_Metadata RVC objects. More...

#include <rvc/metadata.h>

Inheritance diagram for RVC::METADATA:

[legend]

List of all members.

Public Types
enum	FORMAT { FORMAT_Unknown = 0, FORMAT_ISO19115 = 1, FORMAT_FGDC_STD_001_1998 = 2, FORMAT_ISO19139 = 3 }
Public Member Functions
	METADATA (const RVC::METADATA &obj)
	METADATA ()
virtual	~METADATA ()
FORMAT	GetMetadataFormat ()
ERRVALUE	Link (RVC::OBJECT &parent, const FILEPATH &LinkPath, CHAR_ENCODING encoding=CHAR_ENCODING_ISO_2022, FORMAT Format=FORMAT_Unknown, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (RVC::OBJECT &parent, const MISTRING &string, FORMAT Format=FORMAT_Unknown, const CREDENTIALS *Credentials=0)
RVC::METADATA &	operator= (const RVC::METADATA &rhs)
ERRVALUE	Read (MISTRING &string)
Static Public Member Functions
static RVC::OBJTYPESET	GetValidParentSet ()

---

Detailed Description

Manages RVC::OBJTYPE_Metadata RVC objects.

Valid parents for this class:

• RVC::OBJTYPE_File
• RVC::OBJTYPE_Folder
• RVC::OBJTYPE_Table
• All geospatial types

---

Member Enumeration Documentation

enum RVC::METADATA::FORMAT

Enumerator:

FORMAT_Unknown
FORMAT_ISO19115
FORMAT_FGDC_STD_001_1998
FORMAT_ISO19139

---

Constructor & Destructor Documentation

RVC::METADATA::METADATA

(

)

Default constructor.

RVC::METADATA::METADATA

(

const RVC::METADATA &

obj

)

Copy constructor.

virtual RVC::METADATA::~METADATA

(

)

[virtual]

Destructor.

---

Member Function Documentation

FORMAT RVC::METADATA::GetMetadataFormat

(

)

Get format of the metadata, see FORMAT enum for types.

Returns:

FORMAT of the metadata

static RVC::OBJTYPESET RVC::METADATA::GetValidParentSet

(

)

[static]

Get correct OBJTYPESET for all valid METADATA parent OBJTYPE's.

Returns:

OBJTYPESET for all valid METADATA parent OBJTYPE's

ERRVALUE RVC::METADATA::Link	(	RVC::OBJECT &	parent,
		const FILEPATH &	LinkPath,
		CHAR_ENCODING	encoding = CHAR_ENCODING_ISO_2022,
		FORMAT	Format = FORMAT_Unknown,
		const CREDENTIALS *	Credentials = 0
	)

Link to external file with specified encoding Object name, description, and source are filled in automatically with defaults.

Parameters:

	parent	Parent rvc object to create metadata object under
	LinkPath	Path to external text file, stores it as a relative path if possible
	encoding	Encoding of text file
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::METADATA::Make	(	RVC::OBJECT &	parent,
		const MISTRING &	string,
		FORMAT	Format = FORMAT_Unknown,
		const CREDENTIALS *	Credentials = 0
	)

Make a rvc metadata object given parent rvc object and metadata string Object name, description, and source are filled in automatically with defaults.

Parameters:

	parent	Parent rvc object to create metadata object under
	Credentials	User credentials passed in, NULL for default behavior

RVC::METADATA& RVC::METADATA::operator=

(

const RVC::METADATA &

rhs

)

Assignment.

Reimplemented from RVC::TEXTOBJ.

ERRVALUE RVC::METADATA::Read

(

MISTRING &

string

)

Read rvc metadata object into a MISTRING.

Parameters:

string

String to read metadata into

Reimplemented from RVC::TEXTOBJ.

---

The documentation for this class was generated from the following file:

• rvc/metadata.h