psMetadata.h File Reference

---

Detailed Description

Contains metadata struuctures, enumerations and functions prototypes.

This file defines metadata item, metadata type, metadata flags, metadata containers, and function prototypes necessary creating psLib metadata APIs

Author:

Robert DeSonia, MHPCC

Ross Harman, MHPCC

Version:

Revision

1.47

Name

rel6_0

Date:

Date

2005/06/08 23:40:45

Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii

Definition in file psMetadata.h.

#include <stdarg.h>
#include <stdio.h>
#include <sys/types.h>
#include <regex.h>
#include "psHash.h"
#include "psList.h"
#include "psImage.h"
#include "psLookupTable.h"

Include dependency graph for psMetadata.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	PS_META_IS_PRIMITIVE(TYPE)
#define	PS_META_PRIMITIVE_TYPE(METATYPE)
#define	PS_METADATA_FLAGS_MASK   0xFF000000
#define	PS_METADATA_TYPE_MASK   0x00FFFFFF
Typedefs
typedef psMetadata	psMetadata
	Metadata data structure.
typedef psMetadataItem	psMetadataItem
	Metadata item data structure.
Enumerations
enum	psMetadataType {   PS_META_S32 = PS_TYPE_S32, PS_META_F32 = PS_TYPE_F32, PS_META_F64 = PS_TYPE_F64, PS_META_BOOL = PS_TYPE_BOOL, PS_META_LIST = 0x10000, PS_META_STR, PS_META_VEC, PS_META_IMG, PS_META_HASH, PS_META_LOOKUPTABLE,   PS_META_JPEG, PS_META_PNG, PS_META_ASTROM, PS_META_UNKNOWN, PS_META_MULTI, PS_META_META }
	Metadata item type. More...
enum	psMetadataFlags { PS_META_DEFAULT = 0, PS_META_REPLACE = 0x1000000, PS_META_DUPLICATE_OK = 0x2000000 }
	Option flags for psMetadata functions. More...
Functions
psMetadataItem *	psMetadataItemAlloc (const char *name, psMetadataType type, const char *comment,...)
	Create a metadata item.
psMetadataItem *	psMetadataItemAllocStr (const char *name, const char *comment, const char *value)
	Create a metadata item with specified string data.
psMetadataItem *	psMetadataItemAllocF32 (const char *name, const char *comment, psF32 value)
	Create a metadata item with specified psF32 data.
psMetadataItem *	psMetadataItemAllocF64 (const char *name, const char *comment, psF64 value)
	Create a metadata item with specified psF64 data.
psMetadataItem *	psMetadataItemAllocS32 (const char *name, const char *comment, psS32 value)
	Create a metadata item with specified psS32 data.
psMetadataItem *	psMetadataItemAllocBool (const char *name, const char *comment, psBool value)
	Create a metadata item with specified psBool data.
psMetadataItem *	psMetadataItemAllocV (const char *name, psMetadataType type, const char *comment, va_list list)
	Create a metadata item with va_list.
psMetadata *	psMetadataAlloc (void)
	Create a metadata collection.
psBool	psMetadataAddItem (psMetadata *md, psMetadataItem *item, psS32 location, psS32 flags)
	Add existing metadata item to metadata collection.
psBool	psMetadataAdd (psMetadata *md, psS32 location, const char *name, int type, const char *comment,...)
	Create and add a metadata item to metadata collection.
psBool	psMetadataAddV (psMetadata *md, psS32 location, const char *name, int type, const char *comment, va_list list)
	Create and add a metadata item to metadata collection.
psBool	psMetadataAddS32 (psMetadata *md, psS32 location, const char *name, const char *comment, psS32 value)
psBool	psMetadataAddF32 (psMetadata *md, psS32 location, const char *name, const char *comment, psF32 value)
psBool	psMetadataAddF64 (psMetadata *md, psS32 location, const char *name, const char *comment, psF64 value)
psBool	psMetadataAddList (psMetadata *md, psS32 location, const char *name, const char *comment, psList *value)
psBool	psMetadataAddStr (psMetadata *md, psS32 location, const char *name, const char *comment, const char *value)
psBool	psMetadataAddVector (psMetadata *md, psS32 location, const char *name, const char *comment, psVector *value)
psBool	psMetadataAddImage (psMetadata *md, psS32 location, const char *name, const char *comment, psImage *value)
psBool	psMetadataAddHash (psMetadata *md, psS32 location, const char *name, const char *comment, psHash *value)
psBool	psMetadataAddLookupTable (psMetadata *md, psS32 location, const char *name, const char *comment, psLookupTable *value)
psBool	psMetadataAddUnknown (psMetadata *md, psS32 location, const char *name, const char *comment, psPtr value)
psBool	psMetadataAddMetadata (psMetadata *md, psS32 location, const char *name, const char *comment, psMetadata *value)
psBool	psMetadataRemove (psMetadata *md, psS32 where, const char *key)
	Remove an item from metadata collection.
psMetadataItem *	psMetadataLookup (psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name.
psF64	psMetadataLookupF64 (psBool *status, psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name and return its double precision value.
psF32	psMetadataLookupF32 (psBool *status, psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name and return its single precision value.
psS32	psMetadataLookupS32 (psBool *status, psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name and return its integer value.
psBool	psMetadataLookupBool (psBool *status, psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name and return its boolean value.
psPtr	psMetadataLookupPtr (psBool *status, psMetadata *md, const char *key)
	Find an item in the metadata collection based on key name and return its integer value.
psMetadataItem *	psMetadataGet (psMetadata *md, psS32 location)
	Find an item in the metadata collection based on list index.
psMetadataIterator *	psMetadataIteratorAlloc (psMetadata *md, int location, const char *regex)
	Creates a psMetadataIterator to iterate over the specified psMetadata.
psBool	psMetadataIteratorSet (psMetadataIterator *iterator, int location)
	Set the iterator of the psMetadat to a given position.
psMetadataItem *	psMetadataGetAndIncrement (psMetadataIterator *iterator)
	Position the specified iterator to the next matching item in psMetadata, given the regular expression of the iterator.
psMetadataItem *	psMetadataGetAndDecrement (psMetadataIterator *iterator)
	Position the specified iterator to the previous matching item in psMetadata, given the regular expression of the iterator.

---