UDF PROGRAMMERS MANUAL





 Pidf (2S) 
     UDF PROGRAMMERS MANUAL
     Pidf (2S)
 


  NAME   Pidf




 SYNOPSIS  
 #include < stdio.h >
 #include "PidfStr.h"




 struct Pidf {



 u_ByTe_4
     Key;


 FILE
     *Fp;


 ByTe_1
     *Path;


 struct PidfFixed
     Pf;


 struct PidfSizes
     Ps;


 struct PidfQual 
     Pq;


 struct PidfImage
     Pi;


 struct PidfPAng 
     Ap;


 struct PidfSAng 
     As;


 ByTe_1
     ImageDef;


 ByTe_1
     QualDef;


 ByTe_1
     PAngDef;


 ByTe_1
     SAngDef;


 ByTe_2
     MUnits;


 ByTe_2
     MSensors;


 ByTe_2
     MGroups;


 ByTe_2
     MScans;


 ByTe_2
     MAncil;


 ByTe_2
     MModes;


 ByTe_2
     MBins;


 ByTe_2
     MCMisc;


 ByTe_2
     MSMisc;


 ByTe_2
     NFGrp;


 ByTe_2
     NFCMisc;


 ByTe_2
     NFSMisc;


 ByTe_4
     DCMisc;


 ByTe_4
     DSMisc;


 void
     *Groups;


 void
     *Units;


 void
     *Sensors;


 void
     *Scans;


 void
     *Ancil;


 void
     *Modes;


 void
     *Bins;


 void
     *CMisc;


 void
     *SMisc;





 };




 FIELD DEFINITIONS  




 Key
     - 
      The UDF data key obtained from the 
         get_data_key() routine which is
         associated with the current structure contents.


 Fp
     - 
      The file pointer to the PIDF associated with 
         Key.
 

 Path
     - 
      The full pathname of the PIDF associated with 
         Key.


 Pf
     - 
      The structure containing the fixed PIDF field 
         values.


 Ps
     - 
      The structure containing sizes of the PIDF variable
         entry blocks.


 Pq
     - 
      The structure containing the PIDF quality block 
         entries.


 Pi
     - 
      The structure containing the PIDF image block 
         entries.


 Ap
     - 
      The structure containing the PIDF pitch angle 
         block entries.


 As
     - 
      The structure containing the PIDF spin angle 
         block entries.


 ImageDef
     - 
     Image block flag


 



 0
     -
     No Image Block in PIDF


 1
     -
     PIDF contains Image Block.





 QualDef
     - 
     Data Quality block flag


 



 0
     -
     No Data Quality Block in PIDF


 1
     -
     PIDF contains Data Quality Block.





 PAngDef
     - 
     Pitch Angle block flag


 



 0
     -
     No Pitch Angle Block in PIDF


 1
     -
     PIDF contains Pitch Angle Block.





 SAngDef
     - 
     Spin Angle block flag


 



 0
     -
     No Spin Angle Block in PIDF


 1
     -
     PIDF contains Spin Angle Block.





 MUnits
     - 
      The current number of allocated Unit block
         structures in the memory area pointed to by the 
         Units field.


 MSensors
     - 
      The current number of allocated Sensor block
         structures in the memory area pointed to by the 
         Sensors field.


 MGroups
     - 
      The current number of allocated Group name
         pointers in the memory area pointed to by the 
         Groups field.


 MScans
     - 
      The current number of allocated Scan block
         structures in the memory area pointed to by the 
         Scans field.


 MAncil
     - 
      The current number of allocated Ancillary Data 
         block structures in the memory area pointed to by the 
         Ancil field.


 MModes
     - 
      The current number of allocated Mode block 
         structures in the memory area pointed to by the 
         Modes field.


 MBins
     - 
      The current number of allocated Scan Binning 
         block structures in the memory area pointed to by the 
         Bins field.


 MCMisc
     - 
      The current number of 1 byte words allocated in the
         in the memory area pointed to by the CMisc 
         field.


 MSMisc
     - 
      The current number of 2 byte words allocated in the
         in the memory area pointed to by the SMisc 
         field.


 NFGrp
     - 
      Offset into the Groups field to
         the next unused Group Name pointer.


 NFCMisc
     - 
      Offset into the CMisc field to
         the next unused byte.


 NFSMisc
     - 
      Offset into the SMisc field to
         the next unused byte.


 DCMisc
     - 
     Difference between the new and old memory locations
         of the CMisc field after a realloc.


 DSMisc
     - 
     Difference between the new and old memory locations
         of the SMisc field after a realloc.


 Groups
     - 
     Pointer to the memory area which is an array of
         pointers, one to each of the stored group names.


 Units
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Unit definition 
         blocks.


 Sensors
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Sensor 
         definition blocks.


 Scans
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Scan definition 
         blocks.


 Ancil
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Ancillary Data 
         definition blocks.


 Modes
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Mode definition 
         blocks.


 Bins
     - 
     Pointer to the memory area which is an array of
         structures, one for each of the stored Scan Binning 
         definition blocks.


 CMisc
     - 
     Pointer to the general 1-byte memory storage 
         area.


 CMisc
     - 
     Pointer to the general 2-byte memory storage 
         area.







  DESCRIPTION  
 This structure is the top level PIDF information structure.
It contains pointers to the memory locations where all of the PIDF
entries are stored.  In itself it does not directly contain any 
specific PIDF entries.  It is filled with a call to 
ReadPidf().  The fields ImageDef through DSMisc are
all fields used by the PIDF kernel software while building the PIDF
structure and have no purpose once the PIDF information is acquired.




  APPLICABLE FORMATS  
  PIDF V2.0




  SEE ALSO  
PidfRets(2H)
ReadPidf (2)
PidfAnc (2S)
PidfBin (2S)
PidfFixed (2S)
PidfImage (2S)
PidfLatLong (2S)
PidfMode (2S)
PidfPAng (2S)
PidfQual (2S)
PidfSAng (2S)
PidfScan (2S)
PidfSensor (2S)
PidfSizes (2S)
PidfUnit (2S)









 PIDF V2.0 
     August 21, 1999
     PIDF V2.0 










  

    
    TOC
    HOME