objects.logic.configuration.displayConfigurator.displayConfigurator Class Reference

The displayConfigurator class is the interface for the "displaySettings.ini" configuration file, which stores all configuration found in the "Display Settings" window. More...

Inherits objects::logic::configuration::configurator::configurator.

List of all members.

Public Member Functions

def glb_getMinXferOptions
 will return tuple indicating: a) whether min data xfrer is enabled.
def glb_getMaxIdleOptions
 will return tuple indicating: a) whether min data xfrer is enabled.
def glb_getFadeTime
 Returns the total fade time in seconds (max idle time * scale).
def glb_getLineOptions
 Returns the Line options as a tuple.
def glb_getLabelOptions
 Returns the Label options as a tuple.
def glb_getDisplayScale
 Returns the Display Transfer Scale.
def glb_getRefreshRate
 Returns the map refresh rate.
def glb_getDisplayLabel
 Returns the label which should be used to describe each Screen Endpoint.
def app_getProcessColorCodes
def app_getProcessColorCodesDict
def app_getProcessDefaultColor
 returns the default process color
def map_getMapDetail
 Returns a Boolean indicating the level of map detail.
def map_getDrawCSBorders
 Returns a Boolean indicating whether to draw country/state borders onto the map.
def map_getDrawRivers
 Returns a Boolean indicating whether to draw Rivers onto the map.
def glb_setMinXferOptions
 Sets the transfer settings.
def glb_setMaxIdleOptions
 Sets the Max Idle/Hide settings.
def glb_setLineOptions
 Sets the Line Options.
def glb_setLabelOptions
 Sets the Label Options.
def glb_setDisplayScale
 Sets the Display Scale.
def glb_setRefreshRate
 Sets the Refresh Rate.
def glb_setDisplayLabel
 Sets the Display Label.
def app_setProcessColorCodes
 Sets the Application Color as a dictionary of color/value pairs.
def app_setProcessDefaultColor
 Sets the Application Default Color.
def map_setMapDetail
 Sets the map detail level.
def map_setDrawCSBorders
 Sets whether to draw borders onto the map.
def map_setDrawRivers
 Sets whether to draw Rivers onto the map.

Detailed Description

The displayConfigurator class is the interface for the "displaySettings.ini" configuration file, which stores all configuration found in the "Display Settings" window.

All access to this file needs to be done via this object --- Getters ---

Definition at line 31 of file displayConfigurator.py.

Member Function Documentation

def objects.logic.configuration.displayConfigurator.displayConfigurator.app_getProcessColorCodes (   self  ) 

Definition at line 128 of file displayConfigurator.py.

00128                                       :
00129         return self.getSection("AppColorCodes")
00130     
00131     # returns a dictionary of all value/pair items in the [AppColorCodes] section
00132     # @return Dictionary
    def app_getProcessColorCodesDict(self):

def objects.logic.configuration.displayConfigurator.displayConfigurator.app_getProcessColorCodesDict (   self  ) 

Definition at line 133 of file displayConfigurator.py.

00133                                           :
00134         procColorDict = dict()
00135         procColorList = self.app_getProcessColorCodes()
00136         
00137         for proc, color in procColorList:
00138             procColorDict[proc] = color 
00139             
00140         return procColorDict
00141 
    ## returns the default process color

def objects.logic.configuration.displayConfigurator.displayConfigurator.app_getProcessDefaultColor (   self  ) 

returns the default process color

Returns:
String (representing a hex number)

Definition at line 144 of file displayConfigurator.py.

00144                                         :
00145         procDefColor = self.getConfigValue("Application", "proc_default_color", "#FF0000", True)
00146         
00147         return procDefColor
00148     
    ## Returns a Boolean indicating the level of map detail

def objects.logic.configuration.displayConfigurator.displayConfigurator.app_setProcessColorCodes (   self,
  colorCodeDict 
)

Sets the Application Color as a dictionary of color/value pairs.

Parameters:
colorCodeDict Dictionary of Process->Color pairs

Definition at line 273 of file displayConfigurator.py.

00273                                                      :
00274         for processName, color in colorCodeDict.iteritems():
00275             self.setConfigValue("AppColorCodes", processName, color)
00276     
00277     
00278     
    ## Sets the Application Default Color

def objects.logic.configuration.displayConfigurator.displayConfigurator.app_setProcessDefaultColor (   self,
  defColor 
)

Sets the Application Default Color.

Parameters:
defColor String representing default Color value (as a Hex value)

Definition at line 281 of file displayConfigurator.py.

00281                                                   :
00282         self.setConfigValue("Application", "proc_default_color", defColor)
00283     
    ## Sets the map detail level

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getDisplayLabel (   self  ) 

Returns the label which should be used to describe each Screen Endpoint.

Returns:
String

Definition at line 119 of file displayConfigurator.py.

00119                                  :
00120         displayLabel = self.getConfigValue("Global", "display_label", "_DEFAULT_", True)
00121         
00122         return displayLabel
00123         
00124         
00125         
00126     # returns a list all items in the [AppColorCodes] section
00127     # @return List
    def app_getProcessColorCodes(self):

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getDisplayScale (   self  ) 

Returns the Display Transfer Scale.

Returns:
Integer

Definition at line 104 of file displayConfigurator.py.

00104                                  :
00105          dispXs = self.getConfigValue("Global", "display_xfer_scale", "1000000", True)
00106          return int(dispXs)
00107          
00108          
    ## Returns the map refresh rate

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getFadeTime (   self  ) 

Returns the total fade time in seconds (max idle time * scale).

Returns:
Integer

Definition at line 75 of file displayConfigurator.py.

00075                              :
00076        mit  = self.getConfigValue("Global", "max_idle_time", "30", True)
00077        mits = self.getConfigValue("Global", "max_idle_time_scale", "60", True)
00078 
00079        return int(mit) * int(mits)
00080 
00081     
00082     
    ## Returns the Line options as a tuple

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getLabelOptions (   self  ) 

Returns the Label options as a tuple.

Returns:
Tuple

Definition at line 95 of file displayConfigurator.py.

00095                                  :
00096         labs = self.getConfigValue("Global", "labels_show", "Only", True)
00097         labz = self.getConfigValue("Global", "labels_zoom", globalStrings.DISP_SETT_COUNTRY_STATE, True)
00098         
00099         return (labs, labz)
00100     
00101     
    ## Returns the Display Transfer Scale

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getLineOptions (   self  ) 

Returns the Line options as a tuple.

Returns:
Tuple

Definition at line 85 of file displayConfigurator.py.

00085                                 :
00086         lins = self.getConfigValue("Global", "lines_show", "Only", True)
00087         linz = self.getConfigValue("Global", "lines_zoom", globalStrings.DISP_SETT_COUNTRY_STATE, True)
00088         
00089         return (lins, linz)
00090     
00091     
00092     
    ## Returns the Label options as a tuple

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getMaxIdleOptions (   self  ) 

will return tuple indicating: a) whether min data xfrer is enabled.

b) min idle time. c) the scale (i.e. secs, min, hr).

Returns:
Tuple

Definition at line 59 of file displayConfigurator.py.

00059                                    :
00060         mith = self.getConfigValue("Global", "max_idle_time_hide", True, True)
00061         mit  = self.getConfigValue("Global", "max_idle_time", "30", True)
00062         mits = self.getConfigValue("Global", "max_idle_time_scale", "60", True)
00063         
00064         if mith == "True": 
00065             mith = True
00066         else:
00067             mith = False
00068 
00069 
00070         return (mith, int(mit), int(mits))
00071     
00072     
    ## Returns the total fade time in seconds (max idle time * scale)

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getMinXferOptions (   self  ) 

will return tuple indicating: a) whether min data xfrer is enabled.

b) min xfer value. c) the scale (i.e. kb, mb, gb).

Returns:
Tuple

Definition at line 40 of file displayConfigurator.py.

00040                                    :
00041         mdxh = self.getConfigValue("Global", "min_data_xfer_hide", True, True)
00042         mdx = self.getConfigValue("Global", "min_data_xfer", "1000", True)
00043         mdxs = self.getConfigValue("Global", "min_data_xfer_scale", "10", True)
00044         
00045         if mdxh == "True": 
00046             mdxh = True
00047         else:
00048             mdxh = False
00049             
00050         
00051         return (mdxh, int(mdx), int(mdxs))
00052     
00053     
    ## will return tuple indicating:

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_getRefreshRate (   self  ) 

Returns the map refresh rate.

Returns:
String (Low, Med, High)

Definition at line 111 of file displayConfigurator.py.

00111                                 :
00112         refRate = self.getConfigValue("Global", "map_refresh_rate", "Med", True)
00113         
00114         return refRate
00115     
00116     
    ## Returns the label which should be used to describe each Screen Endpoint

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setDisplayLabel (   self,
  displayLabel 
)

Sets the Display Label.

Parameters:
displayLabel display_label value

Definition at line 267 of file displayConfigurator.py.

00267                                                :
00268         self.setConfigValue("Global", "display_label", displayLabel)
00269 
00270         
    ## Sets the Application Color as a dictionary of color/value pairs

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setDisplayScale (   self,
  dispXs 
)

Sets the Display Scale.

Parameters:
dispXs display_xfer_scale value

Definition at line 249 of file displayConfigurator.py.

00249                                          :
00250         dispXs = str(dispXs)
00251         
00252         self.setConfigValue("Global", "display_xfer_scale", dispXs)
00253     
00254     
00255     
    ## Sets the Refresh Rate

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setLabelOptions (   self,
  labs,
  labz 
)

Sets the Label Options.

Parameters:
labs labels_show value
labz labels_zoom value

Definition at line 239 of file displayConfigurator.py.

00239                                                :
00240         labs = str(labs)
00241         labz = str(labz)
00242         
00243         self.setConfigValue("Global", "labels_show", labs)
00244         self.setConfigValue("Global", "labels_zoom", labz)
00245     
00246     
    ## Sets the Display Scale

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setLineOptions (   self,
  lins,
  linz 
)

Sets the Line Options.

Parameters:
lins lines_show value
linz lines_zoom value

Definition at line 228 of file displayConfigurator.py.

00228                                               :
00229         lins = str(lins)
00230         linz = str(linz)
00231         
00232         self.setConfigValue("Global", "lines_show", lins)
00233         self.setConfigValue("Global", "lines_zoom", linz)
00234     
00235     
    ## Sets the Label Options

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setMaxIdleOptions (   self,
  mith,
  mit,
  mits 
)

Sets the Max Idle/Hide settings.

Parameters:
mith max_idle_time_hide value
mit max_idle_time value
mits max_idle_time_scale value

Definition at line 214 of file displayConfigurator.py.

00214                                                       :
00215         mith = str(mith)
00216         mit = str(mit)
00217         mts = str(mits)
00218         
00219         self.setConfigValue("Global", "max_idle_time_hide", mith)
00220         self.setConfigValue("Global", "max_idle_time", mit)
00221         self.setConfigValue("Global", "max_idle_time_scale", mits)
00222     
00223     
00224     
    ## Sets the Line Options

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setMinXferOptions (   self,
  mdxh,
  mdx,
  mdxs 
)

Sets the transfer settings.

Parameters:
mdxh min_data_xfer_hide value
mdx min_data_xfer value
mdxs min_data_xfer_scale value

Definition at line 200 of file displayConfigurator.py.

00200                                                       :        
00201         mdxh = str(mdxh)
00202         mdx  = str(mdx)
00203         mdxs = str(mdxs)
00204         
00205         self.setConfigValue("Global", "min_data_xfer_hide", mdxh)
00206         self.setConfigValue("Global", "min_data_xfer", mdx)
00207         self.setConfigValue("Global", "min_data_xfer_scale", mdxs)
00208         
00209

def objects.logic.configuration.displayConfigurator.displayConfigurator.glb_setRefreshRate (   self,
  refRate 
)

Sets the Refresh Rate.

Parameters:
refRate map_refresh_rate value

Definition at line 258 of file displayConfigurator.py.

00258                                          :
00259         refRate = str(refRate)
00260         
00261         self.setConfigValue("Global", "map_refresh_rate", refRate)
00262     
00263     
00264     
    ## Sets the Display Label

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_getDrawCSBorders (   self  ) 

Returns a Boolean indicating whether to draw country/state borders onto the map.

Returns:
Boolean

Definition at line 165 of file displayConfigurator.py.

00165                                   :
00166         drawCSBorders = self.getConfigValue("Map", "map_draw_cs_borders", "Y", True)        
00167         
00168         if drawCSBorders == "Y": 
00169             drawCSBorders = True
00170         else:
00171             drawCSBorders = False
00172             
00173         return drawCSBorders 
00174     
00175     
00176     
    ## Returns a Boolean indicating whether to draw Rivers onto the map

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_getDrawRivers (   self  ) 

Returns a Boolean indicating whether to draw Rivers onto the map.

Returns:
Boolean

Definition at line 179 of file displayConfigurator.py.

00179                                :
00180         drawRivers = self.getConfigValue("Map", "map_draw_rivers", "N", True)
00181         
00182         if drawRivers == "Y": 
00183             drawRivers = True
00184         else:
00185             drawRivers = False
00186             
00187         return drawRivers        
00188         
00189      
00190     
00191     """
        --- Setters ---

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_getMapDetail (   self  ) 

Returns a Boolean indicating the level of map detail.

Returns:
Boolean (True = High Detail, False = Low Detail)

Definition at line 151 of file displayConfigurator.py.

00151                               :
00152         mapDetailLevel = self.getConfigValue("Map", "map_detail_level", "N", True)
00153         
00154         if mapDetailLevel == "Y": 
00155             mapDetailLevel = True
00156         else:
00157             mapDetailLevel = False
00158                 
00159         return mapDetailLevel
00160     
00161     
00162     
    ## Returns a Boolean indicating whether to draw country/state borders onto the map

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_setDrawCSBorders (   self,
  value 
)

Sets whether to draw borders onto the map.

Parameters:
value Boolean

Definition at line 296 of file displayConfigurator.py.

00296                                          :
00297         if value == True: value = 'Y'
00298         else: value = 'N'
00299         
00300         self.setConfigValue("Map", "map_draw_cs_borders", value)
00301          
00302     
00303     
    ## Sets whether to draw Rivers onto the map

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_setDrawRivers (   self,
  value 
)

Sets whether to draw Rivers onto the map.

Parameters:
value Boolean

Definition at line 306 of file displayConfigurator.py.

00306                                       :
00307         if value == True: value = 'Y'
00308         else: value = 'N'
00309         
00310         self.setConfigValue("Map", "map_draw_rivers", value)
00311 
00312     
00313     
00314 
00315         
00316

def objects.logic.configuration.displayConfigurator.displayConfigurator.map_setMapDetail (   self,
  value 
)

Sets the map detail level.

Parameters:
value True = High, False = Low

Definition at line 286 of file displayConfigurator.py.

00286                                      :
00287         if value == True: value = 'Y'
00288         else: value = 'N'
00289         
00290         self.setConfigValue("Map", "map_detail_level", value)
00291     
00292     
00293     
    ## Sets whether to draw borders onto the map

The documentation for this class was generated from the following file:
Generated on Mon Mar 30 00:26:38 2009 for EyeSpy by  doxygen 1.5.8