Changeset 8665 for trunk/ippdb/src/ippdb.h
- Timestamp:
- Aug 28, 2006, 6:44:34 PM (20 years ago)
- File:
-
- 1 edited
-
trunk/ippdb/src/ippdb.h (modified) (35 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/ippdb/src/ippdb.h
r8543 r8665 1 /* 2 * 3 * This file was generated by glueforge 0.24 4 * 5 * Do NOT directly edit this file. 6 * 7 */ 8 1 9 #ifndef IPPDB_H 2 10 #define IPPDB_H 1 … … 4666 4674 bool mdcf ///< format as mdconfig or simple 4667 4675 ); 4668 /** p2 DoneExpRow data structure4669 * 4670 * Structure for representing a single row of p2 DoneExp table data.4676 /** p2ProcessedExpRow data structure 4677 * 4678 * Structure for representing a single row of p2ProcessedExp table data. 4671 4679 */ 4672 4680 4673 4681 typedef struct { 4674 4682 char *exp_id; 4675 char *recipe;4676 4683 psS32 p1_version; 4677 4684 psS32 p2_version; 4678 } p2 DoneExpRow;4679 4680 /** Creates a new p2 DoneExpRow object4681 * 4682 * @return A new p2 DoneExpRow object or NULL on failure.4683 */ 4684 4685 p2 DoneExpRow *p2DoneExpRowAlloc(4685 } p2ProcessedExpRow; 4686 4687 /** Creates a new p2ProcessedExpRow object 4688 * 4689 * @return A new p2ProcessedExpRow object or NULL on failure. 4690 */ 4691 4692 p2ProcessedExpRow *p2ProcessedExpRowAlloc( 4686 4693 const char *exp_id, 4687 const char *recipe,4688 4694 psS32 p1_version, 4689 4695 psS32 p2_version 4690 4696 ); 4691 4697 4692 /** Creates a new p2 DoneExp table4693 * 4694 * @return true on success 4695 */ 4696 4697 bool p2 DoneExpCreateTable(4698 psDB *dbh ///< Database handle 4699 ); 4700 4701 /** Deletes a p2 DoneExp table4702 * 4703 * @return true on success 4704 */ 4705 4706 bool p2 DoneExpDropTable(4698 /** Creates a new p2ProcessedExp table 4699 * 4700 * @return true on success 4701 */ 4702 4703 bool p2ProcessedExpCreateTable( 4704 psDB *dbh ///< Database handle 4705 ); 4706 4707 /** Deletes a p2ProcessedExp table 4708 * 4709 * @return true on success 4710 */ 4711 4712 bool p2ProcessedExpDropTable( 4707 4713 psDB *dbh ///< Database handle 4708 4714 ); … … 4715 4721 */ 4716 4722 4717 bool p2 DoneExpInsert(4723 bool p2ProcessedExpInsert( 4718 4724 psDB *dbh, ///< Database handle 4719 4725 const char *exp_id, 4720 const char *recipe,4721 4726 psS32 p1_version, 4722 4727 psS32 p2_version … … 4728 4733 */ 4729 4734 4730 long long p2 DoneExpDelete(4735 long long p2ProcessedExpDelete( 4731 4736 psDB *dbh, ///< Database handle 4732 4737 const psMetadata *where, ///< Row match criteria … … 4739 4744 */ 4740 4745 4741 bool p2 DoneExpPop(4746 bool p2ProcessedExpPop( 4742 4747 psDB *dbh, ///< Database handle 4743 4748 char **exp_id, 4744 char **recipe,4745 4749 psS32 *p1_version, 4746 4750 psS32 *p2_version 4747 4751 ); 4748 4752 4749 /** Insert a single p2 DoneExpRow object into a table4753 /** Insert a single p2ProcessedExpRow object into a table 4750 4754 * 4751 4755 * This function constructs and inserts a single row based on it's parameters. … … 4754 4758 */ 4755 4759 4756 bool p2 DoneExpInsertObject(4757 psDB *dbh, ///< Database handle 4758 p2 DoneExpRow *object ///< p2DoneExpRow object4759 ); 4760 4761 /** Insert an array of p2 DoneExpRow object into a table4760 bool p2ProcessedExpInsertObject( 4761 psDB *dbh, ///< Database handle 4762 p2ProcessedExpRow *object ///< p2ProcessedExpRow object 4763 ); 4764 4765 /** Insert an array of p2ProcessedExpRow object into a table 4762 4766 * 4763 4767 * This function constructs and inserts multiple rows based on it's parameters. … … 4766 4770 */ 4767 4771 4768 bool p2 DoneExpInsertObjects(4769 psDB *dbh, ///< Database handle 4770 psArray *objects ///< array of p2 DoneExpRow objects4772 bool p2ProcessedExpInsertObjects( 4773 psDB *dbh, ///< Database handle 4774 psArray *objects ///< array of p2ProcessedExpRow objects 4771 4775 ); 4772 4776 4773 4777 /** Removes the last row from the database and returns it 4774 4778 * 4775 * @return A new p2 DoneExpRow on success or NULL on failure.4776 */ 4777 4778 p2 DoneExpRow *p2DoneExpPopObject(4779 psDB *dbh ///< Database handle 4780 ); 4781 4782 /** Insert data from a binary FITS table p2 DoneExpRow into the database4779 * @return A new p2ProcessedExpRow on success or NULL on failure. 4780 */ 4781 4782 p2ProcessedExpRow *p2ProcessedExpPopObject( 4783 psDB *dbh ///< Database handle 4784 ); 4785 4786 /** Insert data from a binary FITS table p2ProcessedExpRow into the database 4783 4787 * 4784 4788 * This function expects a psFits object with a FITS table as the first … … 4790 4794 */ 4791 4795 4792 bool p2 DoneExpInsertFits(4796 bool p2ProcessedExpInsertFits( 4793 4797 psDB *dbh, ///< Database handle 4794 4798 const psFits *fits ///< psFits object … … 4803 4807 */ 4804 4808 4805 bool p2 DoneExpPopFits(4809 bool p2ProcessedExpPopFits( 4806 4810 psDB *dbh, ///< Database handle 4807 4811 psFits *fits, ///< psFits object … … 4819 4823 */ 4820 4824 4821 bool p2 DoneExpSelectRowsFits(4825 bool p2ProcessedExpSelectRowsFits( 4822 4826 psDB *dbh, ///< Database handle 4823 4827 psFits *fits, ///< psFits object … … 4826 4830 ); 4827 4831 4828 /** Convert a p2 DoneExpRow into an equivalent psMetadata4832 /** Convert a p2ProcessedExpRow into an equivalent psMetadata 4829 4833 * 4830 4834 * @return A psMetadata pointer or NULL on error 4831 4835 */ 4832 4836 4833 psMetadata *p2 DoneExpMetadataFromObject(4834 const p2 DoneExpRow *object ///< fooRow to convert into a psMetadata4837 psMetadata *p2ProcessedExpMetadataFromObject( 4838 const p2ProcessedExpRow *object ///< fooRow to convert into a psMetadata 4835 4839 ); 4836 4840 4837 4841 /** Convert a psMetadata into an equivalent fooRow 4838 4842 * 4839 * @return A p2 DoneExpRow pointer or NULL on error4840 */ 4841 4842 p2 DoneExpRow *p2DoneExpObjectFromMetadata(4843 * @return A p2ProcessedExpRow pointer or NULL on error 4844 */ 4845 4846 p2ProcessedExpRow *p2ProcessedExpObjectFromMetadata( 4843 4847 psMetadata *md ///< psMetadata to convert into a fooRow 4844 4848 ); 4845 /** Selects up to limit rows from the database and returns as p2 DoneExpRow objects in a psArray4849 /** Selects up to limit rows from the database and returns as p2ProcessedExpRow objects in a psArray 4846 4850 * 4847 4851 * See psDBSelectRows() for documentation on the format of where. … … 4850 4854 */ 4851 4855 4852 psArray *p2 DoneExpSelectRowObjects(4853 psDB *dbh, ///< Database handle 4854 const psMetadata *where, ///< Row match criteria 4855 unsigned long long limit ///< Maximum number of elements to return 4856 ); 4857 /** Deletes a row from the database coresponding to an p2 DoneExp4856 psArray *p2ProcessedExpSelectRowObjects( 4857 psDB *dbh, ///< Database handle 4858 const psMetadata *where, ///< Row match criteria 4859 unsigned long long limit ///< Maximum number of elements to return 4860 ); 4861 /** Deletes a row from the database coresponding to an p2ProcessedExp 4858 4862 * 4859 4863 * Note that a 'where' search psMetadata is constructed from each object and … … 4863 4867 */ 4864 4868 4865 bool p2 DoneExpDeleteObject(4866 psDB *dbh, ///< Database handle 4867 const p2 DoneExpRow *object ///< Object to delete4869 bool p2ProcessedExpDeleteObject( 4870 psDB *dbh, ///< Database handle 4871 const p2ProcessedExpRow *object ///< Object to delete 4868 4872 ); 4869 4873 /** Deletes up to limit rows from the database and returns the number of rows actually deleted. … … 4875 4879 */ 4876 4880 4877 long long p2 DoneExpDeleteRowObjects(4881 long long p2ProcessedExpDeleteRowObjects( 4878 4882 psDB *dbh, ///< Database handle 4879 4883 const psArray *objects, ///< Array of objects to delete 4880 4884 unsigned long long limit ///< Maximum number of elements to delete 4881 4885 ); 4882 /** Formats and prints an array of p2 DoneExpRow objects4886 /** Formats and prints an array of p2ProcessedExpRow objects 4883 4887 * 4884 4888 * When mdcf is set the formated output is in psMetadataConfig … … 4888 4892 */ 4889 4893 4890 bool p2 DoneExpPrintObjects(4894 bool p2ProcessedExpPrintObjects( 4891 4895 FILE *stream, ///< a stream 4892 psArray *objects, ///< An array of p2 DoneExpRow objects4896 psArray *objects, ///< An array of p2ProcessedExpRow objects 4893 4897 bool mdcf ///< format as mdconfig or simple 4894 4898 ); 4895 /** p2 DoneImfileRow data structure4896 * 4897 * Structure for representing a single row of p2 DoneImfile table data.4899 /** p2ProcessedImfileRow data structure 4900 * 4901 * Structure for representing a single row of p2ProcessedImfile table data. 4898 4902 */ 4899 4903 … … 4903 4907 char *uri; 4904 4908 char *recipe; 4909 psF64 bg; 4910 psF64 bg_stdev; 4911 psF64 bg_mean_stdev; 4912 char *b1_uri; 4913 char *b2_uri; 4905 4914 psS32 p1_version; 4906 4915 psS32 p2_version; 4907 } p2 DoneImfileRow;4908 4909 /** Creates a new p2 DoneImfileRow object4910 * 4911 * @return A new p2 DoneImfileRow object or NULL on failure.4912 */ 4913 4914 p2 DoneImfileRow *p2DoneImfileRowAlloc(4916 } p2ProcessedImfileRow; 4917 4918 /** Creates a new p2ProcessedImfileRow object 4919 * 4920 * @return A new p2ProcessedImfileRow object or NULL on failure. 4921 */ 4922 4923 p2ProcessedImfileRow *p2ProcessedImfileRowAlloc( 4915 4924 const char *exp_id, 4916 4925 const char *class_id, 4917 4926 const char *uri, 4918 4927 const char *recipe, 4928 psF64 bg, 4929 psF64 bg_stdev, 4930 psF64 bg_mean_stdev, 4931 const char *b1_uri, 4932 const char *b2_uri, 4919 4933 psS32 p1_version, 4920 4934 psS32 p2_version 4921 4935 ); 4922 4936 4923 /** Creates a new p2 DoneImfile table4924 * 4925 * @return true on success 4926 */ 4927 4928 bool p2 DoneImfileCreateTable(4929 psDB *dbh ///< Database handle 4930 ); 4931 4932 /** Deletes a p2 DoneImfile table4933 * 4934 * @return true on success 4935 */ 4936 4937 bool p2 DoneImfileDropTable(4937 /** Creates a new p2ProcessedImfile table 4938 * 4939 * @return true on success 4940 */ 4941 4942 bool p2ProcessedImfileCreateTable( 4943 psDB *dbh ///< Database handle 4944 ); 4945 4946 /** Deletes a p2ProcessedImfile table 4947 * 4948 * @return true on success 4949 */ 4950 4951 bool p2ProcessedImfileDropTable( 4938 4952 psDB *dbh ///< Database handle 4939 4953 ); … … 4946 4960 */ 4947 4961 4948 bool p2 DoneImfileInsert(4962 bool p2ProcessedImfileInsert( 4949 4963 psDB *dbh, ///< Database handle 4950 4964 const char *exp_id, … … 4952 4966 const char *uri, 4953 4967 const char *recipe, 4968 psF64 bg, 4969 psF64 bg_stdev, 4970 psF64 bg_mean_stdev, 4971 const char *b1_uri, 4972 const char *b2_uri, 4954 4973 psS32 p1_version, 4955 4974 psS32 p2_version … … 4961 4980 */ 4962 4981 4963 long long p2 DoneImfileDelete(4982 long long p2ProcessedImfileDelete( 4964 4983 psDB *dbh, ///< Database handle 4965 4984 const psMetadata *where, ///< Row match criteria … … 4972 4991 */ 4973 4992 4974 bool p2 DoneImfilePop(4993 bool p2ProcessedImfilePop( 4975 4994 psDB *dbh, ///< Database handle 4976 4995 char **exp_id, … … 4978 4997 char **uri, 4979 4998 char **recipe, 4999 psF64 *bg, 5000 psF64 *bg_stdev, 5001 psF64 *bg_mean_stdev, 5002 char **b1_uri, 5003 char **b2_uri, 4980 5004 psS32 *p1_version, 4981 5005 psS32 *p2_version 4982 5006 ); 4983 5007 4984 /** Insert a single p2 DoneImfileRow object into a table5008 /** Insert a single p2ProcessedImfileRow object into a table 4985 5009 * 4986 5010 * This function constructs and inserts a single row based on it's parameters. … … 4989 5013 */ 4990 5014 4991 bool p2 DoneImfileInsertObject(4992 psDB *dbh, ///< Database handle 4993 p2 DoneImfileRow *object ///< p2DoneImfileRow object4994 ); 4995 4996 /** Insert an array of p2 DoneImfileRow object into a table5015 bool p2ProcessedImfileInsertObject( 5016 psDB *dbh, ///< Database handle 5017 p2ProcessedImfileRow *object ///< p2ProcessedImfileRow object 5018 ); 5019 5020 /** Insert an array of p2ProcessedImfileRow object into a table 4997 5021 * 4998 5022 * This function constructs and inserts multiple rows based on it's parameters. … … 5001 5025 */ 5002 5026 5003 bool p2 DoneImfileInsertObjects(5004 psDB *dbh, ///< Database handle 5005 psArray *objects ///< array of p2 DoneImfileRow objects5027 bool p2ProcessedImfileInsertObjects( 5028 psDB *dbh, ///< Database handle 5029 psArray *objects ///< array of p2ProcessedImfileRow objects 5006 5030 ); 5007 5031 5008 5032 /** Removes the last row from the database and returns it 5009 5033 * 5010 * @return A new p2 DoneImfileRow on success or NULL on failure.5011 */ 5012 5013 p2 DoneImfileRow *p2DoneImfilePopObject(5014 psDB *dbh ///< Database handle 5015 ); 5016 5017 /** Insert data from a binary FITS table p2 DoneImfileRow into the database5034 * @return A new p2ProcessedImfileRow on success or NULL on failure. 5035 */ 5036 5037 p2ProcessedImfileRow *p2ProcessedImfilePopObject( 5038 psDB *dbh ///< Database handle 5039 ); 5040 5041 /** Insert data from a binary FITS table p2ProcessedImfileRow into the database 5018 5042 * 5019 5043 * This function expects a psFits object with a FITS table as the first … … 5025 5049 */ 5026 5050 5027 bool p2 DoneImfileInsertFits(5051 bool p2ProcessedImfileInsertFits( 5028 5052 psDB *dbh, ///< Database handle 5029 5053 const psFits *fits ///< psFits object … … 5038 5062 */ 5039 5063 5040 bool p2 DoneImfilePopFits(5064 bool p2ProcessedImfilePopFits( 5041 5065 psDB *dbh, ///< Database handle 5042 5066 psFits *fits, ///< psFits object … … 5054 5078 */ 5055 5079 5056 bool p2 DoneImfileSelectRowsFits(5080 bool p2ProcessedImfileSelectRowsFits( 5057 5081 psDB *dbh, ///< Database handle 5058 5082 psFits *fits, ///< psFits object … … 5061 5085 ); 5062 5086 5063 /** Convert a p2 DoneImfileRow into an equivalent psMetadata5087 /** Convert a p2ProcessedImfileRow into an equivalent psMetadata 5064 5088 * 5065 5089 * @return A psMetadata pointer or NULL on error 5066 5090 */ 5067 5091 5068 psMetadata *p2 DoneImfileMetadataFromObject(5069 const p2 DoneImfileRow *object ///< fooRow to convert into a psMetadata5092 psMetadata *p2ProcessedImfileMetadataFromObject( 5093 const p2ProcessedImfileRow *object ///< fooRow to convert into a psMetadata 5070 5094 ); 5071 5095 5072 5096 /** Convert a psMetadata into an equivalent fooRow 5073 5097 * 5074 * @return A p2 DoneImfileRow pointer or NULL on error5075 */ 5076 5077 p2 DoneImfileRow *p2DoneImfileObjectFromMetadata(5098 * @return A p2ProcessedImfileRow pointer or NULL on error 5099 */ 5100 5101 p2ProcessedImfileRow *p2ProcessedImfileObjectFromMetadata( 5078 5102 psMetadata *md ///< psMetadata to convert into a fooRow 5079 5103 ); 5080 /** Selects up to limit rows from the database and returns as p2 DoneImfileRow objects in a psArray5104 /** Selects up to limit rows from the database and returns as p2ProcessedImfileRow objects in a psArray 5081 5105 * 5082 5106 * See psDBSelectRows() for documentation on the format of where. … … 5085 5109 */ 5086 5110 5087 psArray *p2 DoneImfileSelectRowObjects(5088 psDB *dbh, ///< Database handle 5089 const psMetadata *where, ///< Row match criteria 5090 unsigned long long limit ///< Maximum number of elements to return 5091 ); 5092 /** Deletes a row from the database coresponding to an p2 DoneImfile5111 psArray *p2ProcessedImfileSelectRowObjects( 5112 psDB *dbh, ///< Database handle 5113 const psMetadata *where, ///< Row match criteria 5114 unsigned long long limit ///< Maximum number of elements to return 5115 ); 5116 /** Deletes a row from the database coresponding to an p2ProcessedImfile 5093 5117 * 5094 5118 * Note that a 'where' search psMetadata is constructed from each object and … … 5098 5122 */ 5099 5123 5100 bool p2 DoneImfileDeleteObject(5101 psDB *dbh, ///< Database handle 5102 const p2 DoneImfileRow *object ///< Object to delete5124 bool p2ProcessedImfileDeleteObject( 5125 psDB *dbh, ///< Database handle 5126 const p2ProcessedImfileRow *object ///< Object to delete 5103 5127 ); 5104 5128 /** Deletes up to limit rows from the database and returns the number of rows actually deleted. … … 5110 5134 */ 5111 5135 5112 long long p2 DoneImfileDeleteRowObjects(5136 long long p2ProcessedImfileDeleteRowObjects( 5113 5137 psDB *dbh, ///< Database handle 5114 5138 const psArray *objects, ///< Array of objects to delete 5115 5139 unsigned long long limit ///< Maximum number of elements to delete 5116 5140 ); 5117 /** Formats and prints an array of p2 DoneImfileRow objects5141 /** Formats and prints an array of p2ProcessedImfileRow objects 5118 5142 * 5119 5143 * When mdcf is set the formated output is in psMetadataConfig … … 5123 5147 */ 5124 5148 5125 bool p2 DoneImfilePrintObjects(5149 bool p2ProcessedImfilePrintObjects( 5126 5150 FILE *stream, ///< a stream 5127 psArray *objects, ///< An array of p2 DoneImfileRow objects5151 psArray *objects, ///< An array of p2ProcessedImfileRow objects 5128 5152 bool mdcf ///< format as mdconfig or simple 5129 5153 ); … … 5135 5159 typedef struct { 5136 5160 char *exp_id; 5137 char *recipe;5138 5161 psS32 p2_version; 5139 5162 psS32 p3_version; … … 5147 5170 p3PendingExpRow *p3PendingExpRowAlloc( 5148 5171 const char *exp_id, 5149 const char *recipe,5150 5172 psS32 p2_version, 5151 5173 psS32 p3_version … … 5180 5202 psDB *dbh, ///< Database handle 5181 5203 const char *exp_id, 5182 const char *recipe,5183 5204 psS32 p2_version, 5184 5205 psS32 p3_version … … 5204 5225 psDB *dbh, ///< Database handle 5205 5226 char **exp_id, 5206 char **recipe,5207 5227 psS32 *p2_version, 5208 5228 psS32 *p3_version
Note:
See TracChangeset
for help on using the changeset viewer.
