A class for managing data set metadata. More...

#include <ImpExp.h>

Inheritance diagram for VAPoR::ImpExp:

Public Member Functions
	ImpExp ()

virtual	~ImpExp ()

int	Export (const string &path, size_t ts, const string &varname, const size_t min[3], const size_t max[3], const size_t timeseg[2])

int	Import (string path, size_t ts, string *varname, size_t min[3], size_t max[3], size_t timeseg[2])

Public Member Functions inherited from Wasp::MyBase
	MyBase ()

const string &	getClassName () const

Static Public Member Functions
static string	GetPath ()

Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code.

static int	GetErrCode ()
	Retrieve the current error code.

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message.

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

static bool	GetEnableErrMsg ()

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Static Public Attributes inherited from Wasp::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)

Detailed Description

A class for managing data set metadata.

Author: John Clyne

Version: $Revision$

Date: $Date$

The ImpExp class is used to import/export state to/from a VAPoR session

Definition at line 28 of file ImpExp.h.

Constructor & Destructor Documentation

◆ ImpExp()

VAPoR::ImpExp::ImpExp ( )

Create an Import Export object

◆ ~ImpExp()

virtual VAPoR::ImpExp::~ImpExp ( )

virtual

Member Function Documentation

◆ Export()

int VAPoR::ImpExp::Export	(	const string &	path,
		size_t	ts,
		const string &	varname,
		const size_t	min[3],
		const size_t	max[3],
		const size_t	timeseg[2]
	)

Export a volume subregion description for use by another application

This method exports data set state information to facilitate sharing with another application. In particular, the path name of the VDF file, a volume time step, a named volume variable, and volumetric region of interest are exported. The exported information may be retreive via the Import() method

Note: The region bounds are specified relative to the finest resolution volume; Presently the medium of exchange is an XML file, the path to which is internally hardwired and based on the user's uid. Thus it is not possible for applications running under different uid's to share data. Furthermore, there exists only one XML file per uid on a system. This will undoubtedly change in the future.

Parameters

[in]	path	Path to the metadata file
[in]	ts	Time step of exported volume
[in]	varname	Variable name of exported volume
[in]	min	Minimum region extents in voxel coordinates relative to the finest resolution
[in]	max	Maximum region extents in voxel coordinates relative to the finest resolution
[in]	timeseg	Time segment range

Return values

status Returns a non-negative integer on success

See also: Import()

◆ GetPath()

static string VAPoR::ImpExp::GetPath ( )

static

◆ Import()

int VAPoR::ImpExp::Import	(	string *	path,
		size_t *	ts,
		string *	varname,
		size_t	min[3],
		size_t	max[3],
		size_t	timeseg[2]
	)

Import a volume subregion description for use by another application

This method imports data set state information to facilitate sharing with another application. In particular, the path name of the VDF file, a volume time step, a named volume variable, and volumetric region of interest are imported. The imported information is assumed to have been generated via the the most recent call to the Export() method.