HRDIODB
[ class tree: HRDIODB ] [ index: HRDIODB ] [ all elements ]
Packages:
HRDIODB


Tutorials/Manuals:
Package-level: Files:
archive.php
common_class.php
conf.dist.php
convert.php
csv_loader_class.php
day.php
debugging.php
download.php
download_class.php
editmodes.php
field_names.php
file.php
footer.php
generate_offline.php
header.php
hrdi_db_class.php
index.php
login.php
logout.php
mcpear_class.php
mode_class.php
offline_header.php
passreset.php
search.php
search_class.php
search_forms.php
session_class.php
uars_day_class.php
upload_csv.php
user.php
user_class.php
week.php
week_class.php

Classes:
common
csv_loader
download
hrdi_db
mcpear
mode
search
session
uars_day
user
week

Class: mode

Source Location: /mode_class.php

Class Overview




UARS Day mode.









        




Variables







Methods
























Class Details



[line 33]

UARS Day mode.

The mode class represents a single UARS Day mode. Each mode has a set of  data values, as well as a list of all possible Pids.





[ Top ]







Class Variables



	
	

	
$data = array()

	
[line 44]

  Mode data, pulled from the database.


  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$hdb = 

	
[line 38]

  HRDI database instance.


  

	

  

    

      Type:  
      hrdi_db
    

      

	



	
[ Top ]


	
	

	
$internal_fields = array("UARS_Day" => "UARS Day",

                               "Process_ID" => "Process ID",

                               "ID" => "Mode ID")

	
[line 56]

  Internal fields which must be present during submission verification.


  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$numeric_fields = array("Azimuth1" => "Azimuth 1",

                              "Azimuth2" => "Azimuth 2",

                              "Azimuth3" => "Azimuth 3",

                              "Azimuth4" => "Azimuth 4",

                              "Planned" => "Planned flag")

	
[line 64]

  Fields which must contain valid numbers during submission verification.


  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$pids = array()

	
[line 50]

  List of valid pids.


  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]










Class Methods




  

	
	
constructor mode [line 77]

	

    

    

		mode mode(

&$hdb, [integer
$id = 0], hrdi_db
$hdb)
    

    


	
		Constructor.

The mode class constructor. It pulls data for the specific mode out of  the database, as well as a list of all possible Pids.





	
        
Parameters:

    

    

          

        hrdi_db  
        $hdb  
        Instance of the hrdi_db class
      

          

        integer  
        $id  
        Mode id
      

          

          
        &$hdb  
        
      

        

    


        
[ Top ]

  

  

	
	
method add [line 125]

	

    

    

		TRUE|FALSE add(
array
$data)
    

    


	
		Adds a mode.

The add function adds a new mode for a given UARS Day.





	
        
Parameters:

    

    

          

        array  
        $data  
        Mode data
      

        

    


        
[ Top ]

  

  

	
	
method delete [line 153]

	

    

    

		TRUE|FALSE delete(
array
$data)
    

    


	
		Deletes a mode.

The delete function deletes a given mode for a given UARS Day.





	
        
Parameters:

    

    

          

        array  
        $data  
        Mode data
      

        

    


        
[ Top ]

  

  

	
	
method get_description [line 165]

	

    

    

		string get_description(
integer
$p)
    

    


	
		Returns a Pid description.

The function returns the description for a given Pid. The list of Pids  and descriptions is pulled from the database by the mode class  constructor.





Tags:





  

    return:  Pid description
  









	
        
Parameters:

    

    

          

        integer  
        $p  
        Pid number
      

        

    


        
[ Top ]

  

  

	
	
method update [line 139]

	

    

    

		TRUE|FALSE update(
array
$data)
    

    


	
		Updates a mode.

The update function updates a given mode for a given UARS Day.





	
        
Parameters:

    

    

          

        array  
        $data  
        Mode data
      

        

    


        
[ Top ]

  

  

	
	
method verify [line 101]

	

    

    

		TRUE|FALSE verify(

&$data, array
$data)
    

    


	
		Verifies mode data.

The verify function verifies mode data to make sure it's ok to insert  a new mode or update an existing mode.





Tags:





  

    return:  TRUE if verification succeeds, FALSE otherwise
  









	
        
Parameters:

    

    

          

        array  
        $data  
        Mode data
      

          

          
        &$data  
        
      

        

    


        
[ Top ]

  






        

		    

		    Documentation generated on Tue, 23 Jan 2007 22:57:50 -0500 by phpDocumentor 1.3.0RC6