votHandle.c File Reference

(Private) Methods to manage interface handles. More...

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "votParseP.h"

Functions
int	vot_handleCount ()
	Get the number of handle_t used (private method).
handle_t	vot_lookupHandle (Element *elem)
	Lookup the handle_t to an Element (private method).
handle_t	vot_setHandle (Element *elem)
	Assign the Element a handle_t (private method).
void	vot_freeHandle (handle_t handle)
	Free a handle for use (private method).
Element *	vot_getElement (handle_t handle)
	Get the Element refered to by handle_t (private method).
void	vot_handleCleanup (void)
	Free all the handle nodes (private method).
void	vot_newHandleTable (void)
	Initialize a handle table (private method).
void	vot_handleError (char *msg)
	Print an error message.

---

Detailed Description

(Private) Methods to manage interface handles.

VOTHANDLE.C -- (Private) Methods to manage interface handles.

Author:

Mike Fitzpatrick and Eric Timmermann

Date:

8/03/09

---

Function Documentation

vot_freeHandle

(

handle_t

handle

)

Free a handle for use (private method).

vot_freeHandle -- Free a handle for use (private method)

Parameters:

handle

A handle_t to the Element you wish to free

Returns:

nothing

Element * vot_getElement

(

handle_t

handle

)

Get the Element refered to by handle_t (private method).

vot_getElement -- Get the Element refered to by handle_t (private method)

Parameters:

handle

A handle_t to the Element.

Returns:

A pointer to the requested Element.

vot_handleCleanup

(

void

)

Free all the handle nodes (private method).

vot_handleCleanup -- Free all the handle nodes (private method)

Returns:

nothing

int vot_handleCount

(

void

)

Get the number of handle_t used (private method).

count of current used handles vot_handleCount -- Get the number of handle_t used (private method)

Returns:

The number of handle_t types currently stored

vot_handleError

(

char *

msg

)

Print an error message.

vot_handleError -- Print an error message.

Returns:

nothing

handle_t vot_lookupHandle

(

Element *

elem

)

Lookup the handle_t to an Element (private method).

vot_lookupHandle -- Lookup the handle_t to an Element (private method)

Parameters:

*elem

A pointer to an Element

Returns:

A handle_t to the Element

vot_newHandleTable

(

void

)

Initialize a handle table (private method).

vot_newHandleTable -- Initialize a handle table (private method)

Returns:

nothing

handle_t vot_setHandle

(

Element *

elem

)

Assign the Element a handle_t (private method).

vot_setHandle -- Assign the Element a handle_t (private method)

Parameters:

elem

A pointer to an Element to be assigned a handle_t.

Returns:

A handle_t refering to elem