This file defines metadata item, metadata type, metadata flags, metadata containers, and function prototypes necessary creating psLib metadata APIs
Ross Harman, MHPCC
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 "psTime.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.
Data Structures | |
| struct | psMetadata |
| Metadata data structure. More... | |
| struct | psMetadataIterator |
| Metadata iterator. More... | |
| struct | psMetadataItem |
| Metadata item data structure. More... | |
Defines | |
| #define | PS_DATA_IS_PRIMITIVE(TYPE) |
| #define | PS_DATA_PRIMITIVE_TYPE(DATATYPE) |
| #define | PS_METADATA_FLAGS_MASK 0xFF000000 |
| #define | PS_METADATA_TYPE_MASK 0x00FFFFFF |
Enumerations | |
| enum | psMetadataFlags { PS_META_DEFAULT = 0, PS_META_REPLACE = 0x1000000, PS_META_NO_REPLACE = 0x2000000, PS_META_DUPLICATE_OK = 0x4000000, PS_META_NULL = 0x8000000 } |
| Option flags for psMetadata functions. More... | |
Functions | |
| psMetadataItem * | psMetadataItemAlloc (const char *name, psDataType type, const char *comment,...) |
| Create a metadata item. | |
| bool | psMemCheckMetadataItem (psPtr ptr) |
| Checks the type of a particular pointer. | |
| 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 * | psMetadataItemAllocS8 (const char *name, const char *comment, psS8 value) |
| Create a metadata item with specified psS8 data. | |
| psMetadataItem * | psMetadataItemAllocS16 (const char *name, const char *comment, psS16 value) |
| Create a metadata item with specified psS16 data. | |
| psMetadataItem * | psMetadataItemAllocS32 (const char *name, const char *comment, psS32 value) |
| Create a metadata item with specified psS32 data. | |
| psMetadataItem * | psMetadataItemAllocS64 (const char *name, const char *comment, psS64 value) |
| Create a metadata item with specified psS64 data. | |
| psMetadataItem * | psMetadataItemAllocU8 (const char *name, const char *comment, psU8 value) |
| Create a metadata item with specified psU8 data. | |
| psMetadataItem * | psMetadataItemAllocU16 (const char *name, const char *comment, psU16 value) |
| Create a metadata item with specified psU16 data. | |
| psMetadataItem * | psMetadataItemAllocU32 (const char *name, const char *comment, psU32 value) |
| Create a metadata item with specified psU32 data. | |
| psMetadataItem * | psMetadataItemAllocU64 (const char *name, const char *comment, psU64 value) |
| Create a metadata item with specified psU64 data. | |
| psMetadataItem * | psMetadataItemAllocBool (const char *name, const char *comment, bool value) |
| Create a metadata item with specified psBool data. | |
| psMetadataItem * | psMetadataItemAllocPtr (const char *name, psDataType type, const char *comment, psPtr value) |
| Create a metadata item with specified psPtr data. | |
| psMetadataItem * | psMetadataItemAllocV (const char *name, psDataType type, const char *comment, va_list list) |
| Create a metadata item with va_list. | |
| psMetadata * | psMetadataAlloc (void) |
| Create a metadata collection. | |
| bool | psMemCheckMetadata (psPtr ptr) |
| Checks the type of a particular pointer. | |
| psMetadataItem * | psMetadataItemCopy (const psMetadataItem *in) |
| Creates a new copy of a psMetadataItem. | |
| psMetadata * | psMetadataCopy (psMetadata *out, const psMetadata *in) |
| Create a copy of an existing psMetadata collection. | |
| bool | psMetadataItemTransfer (psMetadata *out, const psMetadata *in, const char *key) |
| Copy a metadata item from one psMetadata to another. | |
| bool | psMetadataAddItem (psMetadata *md, const psMetadataItem *item, int location, psS32 flags) |
| Add existing metadata item to metadata collection. | |
| bool | psMetadataAdd (psMetadata *md, long location, const char *name, int format, const char *comment,...) |
| Create and add a metadata item to metadata collection. | |
| bool | psMetadataAddV (psMetadata *md, long location, const char *name, int format, const char *comment, va_list list) |
| Create and add a metadata item to metadata collection. | |
| bool | psMetadataAddBool (psMetadata *md, long location, const char *name, int format, const char *comment, bool value) |
| Add a psBool value to metadata collection. | |
| bool | psMetadataAddS8 (psMetadata *md, long location, const char *name, int format, const char *comment, psS8 value) |
| Add a psS8 value to metadata collection. | |
| bool | psMetadataAddS16 (psMetadata *md, long location, const char *name, int format, const char *comment, psS16 value) |
| Add a psS16 value to metadata collection. | |
| bool | psMetadataAddS32 (psMetadata *md, long location, const char *name, int format, const char *comment, psS32 value) |
| Add a psS32 value to metadata collection. | |
| bool | psMetadataAddS64 (psMetadata *md, long location, const char *name, int format, const char *comment, psS64 value) |
| Add a psS64 value to metadata collection. | |
| bool | psMetadataAddU8 (psMetadata *md, long location, const char *name, int format, const char *comment, psU8 value) |
| Add a psU8 value to metadata collection. | |
| bool | psMetadataAddU16 (psMetadata *md, long location, const char *name, int format, const char *comment, psU16 value) |
| Add a psU16 value to metadata collection. | |
| bool | psMetadataAddU32 (psMetadata *md, long location, const char *name, int format, const char *comment, psU32 value) |
| Add a psU32 value to metadata collection. | |
| bool | psMetadataAddU64 (psMetadata *md, long location, const char *name, int format, const char *comment, psU64 value) |
| Add a psU64 value to metadata collection. | |
| bool | psMetadataAddF32 (psMetadata *md, long location, const char *name, int format, const char *comment, psF32 value) |
| Add a psF32 value to metadata collection. | |
| bool | psMetadataAddF64 (psMetadata *md, long location, const char *name, int format, const char *comment, psF64 value) |
| Add a psF64 value to metadata collection. | |
| psBool | psMetadataAddList (psMetadata *md, long location, const char *name, int format, const char *comment, psList *value) |
| Add a psList to metadata collection. | |
| bool | psMetadataAddStr (psMetadata *md, long location, const char *name, int format, const char *comment, const char *value) |
| Add a string to metadata collection. | |
| psBool | psMetadataAddVector (psMetadata *md, long location, const char *name, int format, const char *comment, psVector *value) |
| Add a vector to metadata collection. | |
| psBool | psMetadataAddArray (psMetadata *md, long location, const char *name, int format, const char *comment, psArray *value) |
| Add a array to metadata collection. | |
| psBool | psMetadataAddImage (psMetadata *md, long location, const char *name, int format, const char *comment, psImage *value) |
| Add an Image to metadata collection. | |
| psBool | psMetadataAddTime (psMetadata *md, long location, const char *name, int format, const char *comment, psTime *value) |
| Add a Time to metadata collection. | |
| psBool | psMetadataAddHash (psMetadata *md, long location, const char *name, int format, const char *comment, psHash *value) |
| Add a Hash to metadata collection. | |
| psBool | psMetadataAddLookupTable (psMetadata *md, long location, const char *name, int format, const char *comment, psLookupTable *value) |
| Add a LookupTable to metadata collection. | |
| psBool | psMetadataAddUnknown (psMetadata *md, long location, const char *name, int format, const char *comment, psPtr value) |
| Add an Unknown (psPtr) to metadata collection. | |
| bool | psMetadataAddPtr (psMetadata *md, long location, const char *name, psDataType type, const char *comment, psPtr value) |
| Add a psPtr to metadata collection. | |
| psBool | psMetadataAddMetadata (psMetadata *md, long location, const char *name, int format, const char *comment, psMetadata *value) |
| Add Metadata to metadata collection. | |
| bool | psMetadataRemove (psMetadata *md, long location, const char *key) |
| Remove an item from metadata collection. | |
| bool | psMetadataRemoveKey (psMetadata *md, const char *key) |
| Removes an item from metadata by key name. | |
| bool | psMetadataRemoveIndex (psMetadata *md, int location) |
| Removes an item from metadata by index number. | |
| psMetadataItem * | psMetadataLookup (const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name. | |
| psF64 | psMetadataLookupF64 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its double precision value. | |
| psF32 | psMetadataLookupF32 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its single precision value. | |
| psS8 | psMetadataLookupS8 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psS16 | psMetadataLookupS16 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psS32 | psMetadataLookupS32 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psS64 | psMetadataLookupS64 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psU8 | psMetadataLookupU8 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psU16 | psMetadataLookupU16 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psU32 | psMetadataLookupU32 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psU64 | psMetadataLookupU64 (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| bool | psMetadataLookupBool (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its boolean value. | |
| psPtr | psMetadataLookupPtr (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its integer value. | |
| psMetadataItem * | psMetadataGet (const psMetadata *md, int location) |
| Find an item in the metadata collection based on list index. | |
| psMetadataIterator * | psMetadataIteratorAlloc (psMetadata *md, long location, const char *regex) |
| Creates a psMetadataIterator to iterate over the specified psMetadata. | |
| bool | psMetadataIteratorSet (psMetadataIterator *iterator, long 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. | |
| psMetadata * | psMetadataLookupMD (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its metadata value. | |
| psString | psMetadataLookupStr (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return its string value. | |
| psTime * | psMetadataLookupTime (bool *status, const psMetadata *md, const char *key) |
| Find an item in the metadata collection based on key name and return it as a psTime pointer. | |
| bool | psMetadataPrint (FILE *fd, const psMetadata *md, int level) |
| Prints metadata collection. | |
| psPolynomial2D * | psPolynomial2DfromMD (psMetadata *folder) |
| bool | psPolynomial2DtoMD (psMetadata *md, psPolynomial2D *poly, char *format,...) |
| psPolynomial3D * | psPolynomial3DfromMD (psMetadata *folder) |
| bool | psPolynomial3DtoMD (psMetadata *md, psPolynomial3D *poly, char *format,...) |
| psPolynomial4D * | psPolynomial4DfromMD (psMetadata *folder) |
| bool | psPolynomial4DtoMD (psMetadata *md, psPolynomial4D *poly, char *format,...) |
1.4.4