Data Abstraction Concepts


Data Structures

struct  pmConceptSpec
 A "concept" specification. More...

Typedefs

typedef psMetadataItem *(*) pmConceptParseFunc (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Function to call to parse a concept once it has been read.
typedef psMetadataItem *(*) pmConceptFormatFunc (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Function to call to format a concept for writing.

Enumerations

enum  pmConceptSource { PM_CONCEPT_SOURCE_NONE = 0x00, PM_CONCEPT_SOURCE_CELLS = 0x01, PM_CONCEPT_SOURCE_DEFAULTS = 0x02, PM_CONCEPT_SOURCE_PHU = 0x04, PM_CONCEPT_SOURCE_HEADER = 0x08, PM_CONCEPT_SOURCE_DATABASE = 0x10, PM_CONCEPT_SOURCE_ALL = 0xff }
 Source for concepts when reading and writing. More...

Functions

pmConceptSpec * pmConceptSpecAlloc (psMetadataItem *blank, pmConceptParseFunc parse, pmConceptFormatFunc format)
 Allocator for pmConceptSpec.
bool pmConceptRegister (psMetadataItem *blank, pmConceptParseFunc parse, pmConceptFormatFunc format, pmFPALevel level)
 Register a new concept for parsing and formatting.
psList * pmConceptsList (pmFPALevel level)
 Get a list of defined concepts for a particular level.
bool pmConceptsRead (pmFPA *fpa, pmChip *chip, pmCell *cell, pmConceptSource source, psDB *db)
 Read the concepts for the given set of fpa, chip, cell.
bool pmConceptsBlankFPA (pmFPA *fpa)
 Set the concepts within the FPA to the blank value.
bool pmConceptsReadFPA (pmFPA *fpa, pmConceptSource source, bool propagateDown, psDB *db)
 Read concepts for an FPA; optionally, read concepts at all lower levels.
bool pmConceptsWriteFPA (const pmFPA *fpa, pmConceptSource source, bool propagateDown, psDB *db)
 Write concepts for an FPA; optionally, write concepts at all lower levels.
bool pmConceptsBlankChip (pmChip *chip)
 Set the concepts within the chip to the blank value.
bool pmConceptsReadChip (pmChip *chip, pmConceptSource source, bool propagateUp, bool propagateDown, psDB *db)
 Read concepts for a chip; optionally, read concepts at the FPA and cell levels.
bool pmConceptsWriteChip (const pmChip *chip, pmConceptSource source, bool propagateUp, bool propagateDown, psDB *db)
 Write concepts for a chip; optionally, write concepts at the FPA and cell levels.
bool pmConceptsBlankCell (pmCell *cell)
 Set the concepts within the cell to the blank value.
bool pmConceptsReadCell (pmCell *cell, pmConceptSource source, bool propagateUp, psDB *db)
 Read concepts for a cell; optionally, read concepts for the parents.
bool pmConceptsWriteCell (const pmCell *cell, pmConceptSource source, bool propagateUp, psDB *db)
 Write concepts for a cell; optionally, write concepts for the parents.
bool pmConceptsInit (void)
 Initialise the concepts system.
void pmConceptsDone (void)
 Signifies that the user is done with the concepts system.
bool pmFPACopyConcepts (pmFPA *target, const pmFPA *source)
 Copy all the concepts within an FPA to another FPA.
bool pmConceptsAverageCells (pmCell *target, psList *sources, psRegion *trimsec, psRegion *biassec)
 Set a variety of concepts in a cell by averaging over several.
psString pmConceptsPhotcodeForView (pmConfig *config, pmFPAfile *file, pmFPAview *view)
 Return the photcode based on the PHOTCODE.RULE in the PHASE2 recipe.
psMetadataItem * p_pmConceptParse_FPA_FILTER (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the FPA.FILTER concept to apply a lookup table.
psMetadataItem * p_pmConceptFormat_FPA_FILTER (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the FPA.FILTER concept to (reverse-)apply a lookup table.
psMetadataItem * p_pmConceptParse_FPA_Coords (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the coordinates concepts: FPA.RA and FPA.DEC.
psMetadataItem * p_pmConceptFormat_FPA_Coords (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the coordinates concepts: FPA.RA and FPA.DEC.
psMetadataItem * p_pmConceptParse_CELL_TRIMSEC (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the CELL.TRIMSEC concept.
psMetadataItem * p_pmConceptParse_CELL_BIASSEC (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the CELL.BIASSEC concept.
psMetadataItem * p_pmConceptParse_CELL_Binning (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the cell binning concepts: CELL.XBIN, CELL.YBIN.
psMetadataItem * p_pmConceptParse_TIMESYS (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the time system concepts: FPA.TIMESYS and CELL.TIMESYS.
psMetadataItem * p_pmConceptParse_TIME (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse the time concepts: FPA.TIME and CELL.TIME.
psMetadataItem * p_pmConceptParse_Positions (const psMetadataItem *concept, const psMetadataItem *pattern, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Parse a cell position concept, e.g., CELL.X0.
psMetadataItem * p_pmConceptFormat_CELL_TRIMSEC (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the CELL.TRIMSEC concept.
psMetadataItem * p_pmConceptFormat_CELL_BIASSEC (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the CELL.BIASSEC concept.
psMetadataItem * p_pmConceptFormat_CELL_XBIN (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the CELL.XBIN concept.
psMetadataItem * p_pmConceptFormat_CELL_YBIN (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the CELL.YBIN concept.
psMetadataItem * p_pmConceptFormat_TIMESYS (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the time system concepts: FPA.TIMESYS and CELL.TIMESYS.
psMetadataItem * p_pmConceptFormat_TIME (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format the time concepts: FPA.TIME and CELL.TIME.
psMetadataItem * p_pmConceptFormat_Positions (const psMetadataItem *concept, const psMetadata *cameraFormat, const pmFPA *fpa, const pmChip *chip, const pmCell *cell)
 Format a cell position concept, e.g., CELL.X0.
bool p_pmConceptsWriteToCells (const psMetadata *specs, const pmCell *cell, const psMetadata *concepts)
 "Write" concepts to (actually, check against) the camera format file's CELLS.
bool p_pmConceptsWriteToDefaults (const psMetadata *specs, const pmFPA *fpa, const pmChip *chip, const pmCell *cell, const psMetadata *concepts)
 "Write" concepts to (actually, check against) the camera format file's DEFAULTS.
bool p_pmConceptsWriteToHeader (const psMetadata *specs, const pmFPA *fpa, const pmChip *chip, const pmCell *cell, const psMetadata *concepts)
 "Write" concepts to (actually, add to, pending a later write) the FITS header.
bool p_pmConceptsWriteToDatabase (const psMetadata *specs, const pmFPA *fpa, const pmChip *chip, const pmCell *cell, psDB *db, const psMetadata *concepts)
 Write concepts to the database.

Typedef Documentation

typedef psMetadataItem*(*) pmConceptFormatFunc(const psMetadataItem *concept,const psMetadata *cameraFormat,const pmFPA *fpa,const pmChip *chip,const pmCell *cell)

Function to call to format a concept for writing.

Definition at line 31 of file pmConcepts.h.

typedef psMetadataItem*(*) pmConceptParseFunc(const psMetadataItem *concept,const psMetadataItem *pattern,const psMetadata *cameraFormat,const pmFPA *fpa,const pmChip *chip,const pmCell *cell)

Function to call to parse a concept once it has been read.

Definition at line 22 of file pmConcepts.h.

Enumeration Type Documentation

enum pmConceptSource

Source for concepts when reading and writing.

Since some sources become available at different times from others, we need to provide some specificity to reading and writing concepts (or we're forced to wait until everything's available, which we don't want to do). Concepts may be read from or written to multiple sources at once by OR-ing them.

Enumerator:
PM_CONCEPT_SOURCE_NONE  No concepts.
PM_CONCEPT_SOURCE_CELLS  Concept comes from the camera information.
PM_CONCEPT_SOURCE_DEFAULTS  Concept comes from defaults.
PM_CONCEPT_SOURCE_PHU  Concept comes from PHU.
PM_CONCEPT_SOURCE_HEADER  Concept comes from FITS header.
PM_CONCEPT_SOURCE_DATABASE  Concept comes from database.
PM_CONCEPT_SOURCE_ALL  All concepts.

Definition at line 73 of file pmConcepts.h.

Function Documentation

psMetadataItem* p_pmConceptFormat_CELL_BIASSEC ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the CELL.BIASSEC concept.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_CELL_TRIMSEC ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the CELL.TRIMSEC concept.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_CELL_XBIN ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the CELL.XBIN concept.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_CELL_YBIN ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the CELL.YBIN concept.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_FPA_Coords ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the coordinates concepts: FPA.RA and FPA.DEC.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_FPA_FILTER ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the FPA.FILTER concept to (reverse-)apply a lookup table.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_Positions ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format a cell position concept, e.g., CELL.X0.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_TIME ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the time concepts: FPA.TIME and CELL.TIME.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptFormat_TIMESYS ( const psMetadataItem *  concept,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Format the time system concepts: FPA.TIMESYS and CELL.TIMESYS.

Parameters:
concept  Concept to format
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_CELL_BIASSEC ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the CELL.BIASSEC concept.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_CELL_Binning ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the cell binning concepts: CELL.XBIN, CELL.YBIN.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_CELL_TRIMSEC ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the CELL.TRIMSEC concept.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_FPA_Coords ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the coordinates concepts: FPA.RA and FPA.DEC.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_FPA_FILTER ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the FPA.FILTER concept to apply a lookup table.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_Positions ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse a cell position concept, e.g., CELL.X0.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_TIME ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the time concepts: FPA.TIME and CELL.TIME.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

psMetadataItem* p_pmConceptParse_TIMESYS ( const psMetadataItem *  concept,
const psMetadataItem *  pattern,
const psMetadata *  cameraFormat,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell 
)

Parse the time system concepts: FPA.TIMESYS and CELL.TIMESYS.

Parameters:
concept  Concept to parse
pattern  Pattern to use in parsing
cameraFormat  Camera format definition
fpa  FPA for concept, or NULL
chip  Chip for concept, or NULL
cell  Cell for concept, or NULL

bool p_pmConceptsWriteToCells ( const psMetadata *  specs,
const pmCell *  cell,
const psMetadata *  concepts 
)

"Write" concepts to (actually, check against) the camera format file's CELLS.

Examines the CELLS metadata in the camera format file for the current type of cell, and checks that the concepts as defined there match the ones defined in the cell. A warning is produced if the concepts do not match.

Parameters:
specs  The concept specifications
cell  The cell
concepts  The concepts

bool p_pmConceptsWriteToDatabase ( const psMetadata *  specs,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell,
psDB *  db,
const psMetadata *  concepts 
)

Write concepts to the database.

Examines the DATABASE metadata in the camera format file, and writes concepts to the database. Warning: This function has not been tested; use at your own risk.

Parameters:
specs  The concept specifications
fpa  The FPA
chip  The chip
cell  The cell
db  The database handle
concepts  The concepts

bool p_pmConceptsWriteToDefaults ( const psMetadata *  specs,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell,
const psMetadata *  concepts 
)

"Write" concepts to (actually, check against) the camera format file's DEFAULTS.

Examines the DEFAULTS metadata in the camera format file, and checks that the concepts as defined there match the ones defined in the cell. A warning is produced if the concepts do not match.

Parameters:
specs  The concept specifications
fpa  The FPA
chip  The chip
cell  The cell
concepts  The concepts

bool p_pmConceptsWriteToHeader ( const psMetadata *  specs,
const pmFPA *  fpa,
const pmChip *  chip,
const pmCell *  cell,
const psMetadata *  concepts 
)

"Write" concepts to (actually, add to, pending a later write) the FITS header.

Examines the FITS header TRANSLATION metadata in the camera format file, and writes concepts to the appropriate FITS headers in the HDU, in preparation for a future write of the HDU.

Parameters:
specs  The concept specifications
fpa  The FPA
chip  The chip
cell  The cell
concepts  The concepts

bool pmConceptRegister ( psMetadataItem *  blank,
pmConceptParseFunc  parse,
pmConceptFormatFunc  format,
pmFPALevel  level 
)

Register a new concept for parsing and formatting.

Defines a new concept, based on the blank value (with name and default comment), and functions to parse and format the concept. The new concept is registered at the specified level (FPA, chip or cell). If the parse function is NULL, then a default parse function is used, which performs minimal parsing. Similarly for the format function.

Parameters:
blank  Blank value; contains the name and default comment
parse  Function to call to parse the concept, or NULL
format  Function to call to format the concept, or NULL
level  Level at which to store concept in the FPA hierarchy

bool pmConceptsAverageCells ( pmCell *  target,
psList *  sources,
psRegion *  trimsec,
psRegion *  biassec 
)

Set a variety of concepts in a cell by averaging over several.

In some instances, we want to combine the values of a concept for several cells into a single concept for a single cell (e.g., when mosaicking multiple cells into a chip with one "cell"). This function averages the values of various concepts:

Parameters:
target  Target cell
sources  List of source cells
trimsec  The new trim section
biassec  The new bias section

bool pmConceptsBlankCell ( pmCell *  cell  ) 

Set the concepts within the cell to the blank value.

Parameters:
cell  Cell for which to set blank concepts

bool pmConceptsBlankChip ( pmChip *  chip  ) 

Set the concepts within the chip to the blank value.

Parameters:
chip  FPA for which to set blank concepts

bool pmConceptsBlankFPA ( pmFPA *  fpa  ) 

Set the concepts within the FPA to the blank value.

Parameters:
fpa  FPA for which to set blank concepts

void pmConceptsDone ( void   ) 

Signifies that the user is done with the concepts system.

Frees the registered concepts so there is no memory leak when the user checks "persistent" memory.

bool pmConceptsInit ( void   ) 

Initialise the concepts system.

Register the standard concepts, so that concepts may be read and written. This function is called automatically the first time the concepts functions are used.

psList* pmConceptsList ( pmFPALevel  level  ) 

Get a list of defined concepts for a particular level.

pmConceptSpec* pmConceptSpecAlloc ( psMetadataItem *  blank,
pmConceptParseFunc  parse,
pmConceptFormatFunc  format 
)

Allocator for pmConceptSpec.

Parameters:
blank  Blank value; contains the name
parse  Function to call to parse the concept
format  Function to call to format the concept

psString pmConceptsPhotcodeForView ( pmConfig *  config,
pmFPAfile *  file,
pmFPAview *  view 
)

Return the photcode based on the PHOTCODE.RULE in the PHASE2 recipe.

A photometry code ("photcode") is a string that represents the combination of filter and detector (chip). This functions generates a photcode for a particular chip within the FPA, based on the PHOTCODE.RULE in the PHASE2 recipe. Interpolation using the usual syntax (e.g., "{CHIP.NAME}") is permitted.

bool pmConceptsRead ( pmFPA *  fpa,
pmChip *  chip,
pmCell *  cell,
pmConceptSource  source,
psDB *  db 
)

Read the concepts for the given set of fpa, chip, cell.

Attempts to read as many concepts as possible from the specified source for the specified FPA, chip and cell. That is, it will read chip- and cell-level concepts in addition to fpa-level concepts, if the chip and cell are provided.

Parameters:
fpa  FPA for which to read concepts
chip  Chip for which to read concepts, or NULL
cell  Cell for which to read concepts, or NULL
source  The source of the concepts to read
db  Database handle

bool pmConceptsReadCell ( pmCell *  cell,
pmConceptSource  source,
bool  propagateUp,
psDB *  db 
)

Read concepts for a cell; optionally, read concepts for the parents.

Once concepts should be available for reading at the FPA-level, this function attempts to read the concepts from the specified source. It also allows concepts to be read at upper levels through the parents (note, it would not read concepts for all chips, but only the parent of this cell).

Parameters:
cell  Cell for which to read concepts
source  Source for concepts
propagateUp  Propagate to higher levels?
db  Database handle

bool pmConceptsReadChip ( pmChip *  chip,
pmConceptSource  source,
bool  propagateUp,
bool  propagateDown,
psDB *  db 
)

Read concepts for a chip; optionally, read concepts at the FPA and cell levels.

Once concepts should be available for reading at the FPA-level, this function attempts to read the concepts from the specified source. It also allows concepts to be read at the fpa level (through the parent), and the cell level by iterating over the components.

Parameters:
chip  Chip for which to read concepts
source  Source for concepts
propagateUp  Propagate to higher levels?
propagateDown  Propagate to lower levels?
db  Database handle

bool pmConceptsReadFPA ( pmFPA *  fpa,
pmConceptSource  source,
bool  propagateDown,
psDB *  db 
)

Read concepts for an FPA; optionally, read concepts at all lower levels.

Once concepts should be available for reading at the FPA-level, this function attempts to read the concepts from the specified source. It also allows concepts to be read at lower levels by iterating over the components.

Parameters:
fpa  FPA for which to read concepts
source  Source for concepts
propagateDown  Propagate to lower levels?
db  Database handle

bool pmConceptsWriteCell ( const pmCell *  cell,
pmConceptSource  source,
bool  propagateUp,
psDB *  db 
)

Write concepts for a cell; optionally, write concepts for the parents.

This function writes all concepts for the chip to the specified "source". It also allows concepts to be written for the upper levels through the parents (note, it would not write concepts for all chips, but only the parent of this cell).

Parameters:
cell  FPA for which to write concepts
source  Source for concepts
propagateUp  Propagate to higher levels?
db  Database handle

bool pmConceptsWriteChip ( const pmChip *  chip,
pmConceptSource  source,
bool  propagateUp,
bool  propagateDown,
psDB *  db 
)

Write concepts for a chip; optionally, write concepts at the FPA and cell levels.

This function writes all concepts for the chip to the specified "source". It also allows concepts to be written for the FPA, and the cell level by iterating over the components.

Parameters:
chip  Chip for which to write concepts
source  Source for concepts
propagateUp  Propagate to higher levels?
propagateDown  Propagate to lower levels?
db  Database handle

bool pmConceptsWriteFPA ( const pmFPA *  fpa,
pmConceptSource  source,
bool  propagateDown,
psDB *  db 
)

Write concepts for an FPA; optionally, write concepts at all lower levels.

This function writes all concepts for the FPA to the specified "source". It also allows concepts to be written for all lower levels by iterating over the components.

Parameters:
fpa  FPA for which to write concepts
source  Source for concepts
propagateDown  Propagate to lower levels?
db  Database handle

bool pmFPACopyConcepts ( pmFPA *  target,
const pmFPA *  source 
)

Copy all the concepts within an FPA to another FPA.

Iterates over all components of the FPA, and copies the concepts metadata from the source to the target.

Parameters:
target  The target FPA
source  The source FPA

Generated on Fri Feb 2 22:35:59 2007 for Pan-STARRS Module Library by  doxygen 1.5.1