svkDataAcquisitionDescriptionXML.h File Reference

#include <vtkObject.h>
#include <vtkXMLDataElement.h>
#include <svkSatBandsXML.h>
#include <svkXMLUtils.h>
#include "svkTypes.h"

Go to the source code of this file.

Classes
class	svkDataAcquisitionDescriptionXML

Namespaces
	svk

Functions
void *	svkDataAcquisitionDescriptionXML_New ()
void *	svkDataAcquisitionDescriptionXML_Delete (void *dataAcquisitionDescriptionXML)
void *	svkDataAcquisitionDescriptionXML_Read (const char *xmlFileName, int *status)
int	svkDataAcquisitionDescriptionXML_WriteXMLFile (const char *filepath, void *xml)
const char *	svkDataAcquisitionDescriptionXML_GetDataWithPath (void *xml, const char *path)
int	svkDataAcquisitionDescriptionXML_SetDataWithPath (void *xml, const char *path, const char *data)
int	svkDataAcquisitionDescriptionXML_AddElementWithParentPath (void *xml, const char *path, const char *name)
int	svkDataAcquisitionDescriptionXML_RemoveElementWithParentPath (void *xml, const char *path, const char *name)
void *	svkDataAcquisitionDescriptionXML_GetSatBandsXML (void *dataAcquisitionDescriptionXML)
void	svkDataAcquisitionDescriptionXML_SetTrajectory (const char *type, const char *id, const char *comment, void *xml)
const char *	svkDataAcquisitionDescriptionXML_GetTrajectoryType (void *xml)
const char *	svkDataAcquisitionDescriptionXML_GetTrajectoryID (void *xml)
const char *	svkDataAcquisitionDescriptionXML_GetTrajectoryComment (void *xml)
void	svkDataAcquisitionDescriptionXML_SetTrajectoryLongParameter (const char *name, long value, void *xml)
long	svkDataAcquisitionDescriptionXML_GetTrajectoryLongParameter (const char *name, void *xml)
void	svkDataAcquisitionDescriptionXML_SetTrajectoryDoubleParameter (const char *name, double value, void *xml)
double	svkDataAcquisitionDescriptionXML_GetTrajectoryDoubleParameter (const char *name, void *xml)

Detailed Description

This header file contains the declaration of the svk::svkDataAcquisitionDescriptionXML class. Additionally it contains a set of C methods for creating, deleting and interacting with the object. This is to provide access to the functionality of the class in C programs.

Function Documentation

int svkDataAcquisitionDescriptionXML_AddElementWithParentPath	(	void *	xml,
		const char *	path,
		const char *	name
	)

Add an xml element with the given parent path and name. The element will be initially empty but its value should be set with svkDataAcquisitionDescriptionXML_SetDataWithPath().

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object
path	the xpath of the parent to which you wish add the element to
name	the name of the element to add

Returns

0 on success

References NULL_XML_ERROR.

void* svkDataAcquisitionDescriptionXML_Delete

(

void *

xml

)

C method for releasing an svk::svkDataAcquisitionDescriptionXML object.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML to be deleted

Returns

always NULL

References NULL_XML_ERROR.

const char* svkDataAcquisitionDescriptionXML_GetDataWithPath	(	void *	xml,
		const char *	path
	)

Generic getter for pulling the data or contents of an xml element.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object
path	the xpath of the requested XML element

Returns

the contents of the requested element

References NULL_XML_ERROR.

void* svkDataAcquisitionDescriptionXML_GetSatBandsXML

(

void *

xml

)

C method for getting the internal svk::svkSatBandsXML object.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object

Returns

a void pointer to the internal svk::svkSatBandsXML object.

References svkDataAcquisitionDescriptionXML::GetSatBandsXML(), and NULL_XML_ERROR.

const char* svkDataAcquisitionDescriptionXML_GetTrajectoryComment

(

void *

xml

)

C method for getting the contents of the encoding/trajectoryDescription/comment element.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object

Returns

the contents of the encoding/trajectoryDescription/comment element

References NULL_XML_ERROR.

double svkDataAcquisitionDescriptionXML_GetTrajectoryDoubleParameter	(	const char *	name,
		void *	xml
	)

C method for getting the contents of an encoding/trajectoryDescription/userParameterDouble element.

Parameters

name	the name of the user parameter
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML

Returns

the value of the user element as a double

References NULL_XML_ERROR.

const char* svkDataAcquisitionDescriptionXML_GetTrajectoryID

(

void *

xml

)

C method for getting the contents of the encoding/trajectoryDescription/identifier element.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object

Returns

the contents of the encoding/trajectoryDescription/identifier element

References NULL_XML_ERROR.

long svkDataAcquisitionDescriptionXML_GetTrajectoryLongParameter	(	const char *	name,
		void *	xml
	)

C method for getting the contents of an encoding/trajectoryDescription/userParameterLong element.

Parameters

name	the name of the user parameter
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML

Returns

the value of the user element as a long

References NULL_XML_ERROR.

const char* svkDataAcquisitionDescriptionXML_GetTrajectoryType

(

void *

xml

)

C method for getting the contents of the encoding/trajectory element.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object

Returns

the contents of the encoding/trajectory element

References NULL_XML_ERROR.

void* svkDataAcquisitionDescriptionXML_New

(

)

C method for instantiating a new svk::svkDataAcquisitionDescriptionXML object. This will initialized the root xml data element.

Returns

a void pointer to the svk::svkDataAcquisitionDescriptionXML object

References svkDataAcquisitionDescriptionXML::InitializeEmptyXMLFile(), and svkDataAcquisitionDescriptionXML::New().

void* svkDataAcquisitionDescriptionXML_Read	(	const char *	xmlFileName,
		int *	status
	)

C method for a new svk::svkDataAcquisitionDescriptionXML object and initializing it from a file.

Parameters

xmlFileName	the xml file to be read
status	reference to a status variable. Will be set to 1 on error.

Returns

a void pointer to the svk::svkDataAcquisitionDescriptionXML object

References svkDataAcquisitionDescriptionXML::New(), and svkDataAcquisitionDescriptionXML::SetXMLFileName().

int svkDataAcquisitionDescriptionXML_RemoveElementWithParentPath	(	void *	xml,
		const char *	path,
		const char *	name
	)

Remove a data element with the given parent path and name.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object
path	the xpath of the parent from which you wish to remove an element
name	the name of the element to remove

Returns

0 on success

References NULL_XML_ERROR.

int svkDataAcquisitionDescriptionXML_SetDataWithPath	(	void *	xml,
		const char *	path,
		const char *	data
	)

Generic setter for the data or contents of a given xml element.

Parameters

xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML object
path	the xpath of the requested element to set the contents of
data	the data to set into the requested elment.

Returns

0 on success

References NULL_XML_ERROR.

void svkDataAcquisitionDescriptionXML_SetTrajectory	(	const char *	type,
		const char *	id,
		const char *	comment,
		void *	xml
	)

C method for setting the basic trajectory element. This includes setting the encoding/trajectory element the encoding/trajectoryDescription/identifier element and the encoding/trajectoryDescription/comment element.

Parameters

type	the contents of the trajectory element
id	the contents of the encoding/trajectoryDescription/identifier element
comment	the contents of the encoding/trajectoryDescription/comment element
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML

References NULL_XML_ERROR.

void svkDataAcquisitionDescriptionXML_SetTrajectoryDoubleParameter	(	const char *	name,
		double	value,
		void *	xml
	)

C method for setting the contents of an encoding/trajectoryDescription/userParameterDouble element. This includes setting name and value child elements.

Parameters

name	the name of the user parameter
value	the value of the user parameter
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML

References NULL_XML_ERROR.

void svkDataAcquisitionDescriptionXML_SetTrajectoryLongParameter	(	const char *	name,
		long	value,
		void *	xml
	)

C method for setting the contents of an encoding/trajectoryDescription/userParameterLong element. This includes setting name and value child elements.

Parameters

name	the name of the user parameter
value	the value of the user parameter
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML

References NULL_XML_ERROR.

int svkDataAcquisitionDescriptionXML_WriteXMLFile	(	const char *	filepath,
		void *	xml
	)

C method for writing the xml to disk.

Parameters

filepath	the path to the file to be written.
xml	a void pointer to the svk::svkDataAcquisitionDescriptionXML to be written

References NULL_XML_ERROR.