File /std/room/inherit/carriage/handler.c

Written by Pinkfish

Started Mon Mar 4 23:34:31 PST 2002

Includes

Method index

• delete_route(string)
  Delete a route from the handler.
• load_data()
• query_carriage_on_route(string)
  This method returns the carriage object on the specified route.
• query_route_actual()
  This method returns all the actual actual routes and where they are.
• query_route_details()
  Query the details of the route.
• query_route_names()
  This method returns all the names of all the different routes in the system.
• query_route_stops(string)
  This method returns the list of stops associated with the route.
• query_stop_delay(string)
  This method returns the delay of the stop, the actual room.
• query_stop_location(string)
  This method returns the location of the stop, the actual room.
• query_stop_name(string)
  This method returns the name of the stop, the actual room.
• scan_for_new_data()
  This method scans through all the files and sees if anything has changed.
• setup_carriage(string, string, string, string, string)
  This method sets up the carriage handler stuff.

Public Functions

These are functions that everyone can access.

.

delete_route

int delete_route(string route)


Delete a route from the handler.

• Parameters:
  route - the route name to delete
• Returns:
  1 if successful

load_data

void load_data()

query_carriage_on_route

object query_carriage_on_route(string route)


This method returns the carriage object on the specified route.

• Parameters:
  route - the route to look for the carriage on
• Returns:
  the carriage on the route
  query_route_actual

  mapping query_route_actual()
  

  
  This method returns all the actual actual routes and where they are. This should only be used for debugging purposes.
  
  • Returns:
    the actual route details
    query_route_details

    mapping query_route_details()
    

    
    Query the details of the route. This returns everything about the details and should not be used.
    
    • Returns:
      all the route details
      query_route_names

      string * query_route_names()
      

      
      This method returns all the names of all the different routes in the system.
      
      • Returns:
        the route names
        query_route_stops

        class stop_list_details * query_route_stops(string route)
        

        
        This method returns the list of stops associated with the route.
        
        • Parameters:
          route - the name of the route
        • Returns:
          the stops on the route
          query_stop_delay

          int query_stop_delay(string name)
          

          
          This method returns the delay of the stop, the actual room.
          
          • Parameters:
            name - the name of the stop
          • Returns:
            the delay of the stop
            query_stop_location

            string query_stop_location(string name)
            

            
            This method returns the location of the stop, the actual room.
            
            • Parameters:
              name - the name of the stop
            • Returns:
              the location of the stop
              query_stop_name

              string query_stop_name(string name)
              

              
              This method returns the name of the stop, the actual room.
              
              • Parameters:
                name - the name of the stop
              • Returns:
                the name of the stop
                scan_for_new_data

                void scan_for_new_data()
                

                
                This method scans through all the files and sees if anything has changed.
                setup_carriage

                void setup_carriage(string dir,
                                    string base_dir,
                                    string carriage,
                                    string pole,
                                    string save_file)
                

                
                This method sets up the carriage handler stuff. It sets up the pole and the carriage items.
                
                • Parameters:
                  dir - the directory of the data files
                  base_dir - the base directory to use on the front of paths
                  carriage - what to clone for the carriage
                  pole - what to clone for a pole
                  save_file - where to save the data