|
Configuration Class Reference (PyVrCfg)
VrOne/Python Configuration Class More...
Members
Description
The Configuration class allows various VrOne configuration parameters to be viewed and changed.
Example:
from pycfg import *
Cfg = VrCfg ()
(VrVersion) = Cfg.GetVrVersion ()
Member Function Documentation
Load (FileName)
Loads configuration from disk.
FileName
|
Configuration file name. (0=Use default)
|
returns
|
(ret)
|
|
ret
|
returns 0 = OK 1 = File did not exist and was created. -1 = Could not open file.
|
Rec ()
Records the current configuration.
returns
|
(ret)
|
|
ret
|
0=Success, 1=Failed
|
GetVrVersion ()
Returns the VrOne version string.
returns
|
(VrVersion)
|
|
VrVersion
|
VrOne version string
|
SetUseDefaultDir (UseDefaultDir)
Sets whether or not VrOne uses default directories.
UseDefaultDir
|
0=Don't use default directories, 1=Use default directories
|
UseDefaultDir ()
Returns status of default directory usage.
returns
|
(ret)
|
|
ret
|
0=Not using default directories, 1=Using default directories
|
SetDefaultDir (ProgNum, DefaultDir)
Sets the default directory for a program
ProgNum
|
Program number
|
DefaultDir
|
Default directory
|
GetDefaultDir (ProgNum, Override)
Returns the default directory for a program. If UseDefaultDir is FALSE then NULL is returned
ProgNum
|
Program number (see vrcfg.h)
|
Override
|
TRUE - Always return default directory FALSE - If UseDefaultDir is FALSE then NULL is returned
|
returns
|
(ret)
|
|
ret
|
Default directory
|
GetSymFileName ()
Gets the current symbol filename.
returns
|
(ret)
|
|
ret
|
Current symbol filename.
|
SetSymFileName (FileName)
Sets the current symbol filename. The specified symbol file is loaded.
FileName
|
Name of symbol file to load.
|
GetCharSetDir ()
Returns the directory that the character set files are in.
returns
|
(ret)
|
|
ret
|
Directory of character set files.
|
GetColorTableScreen ()
Returns the color table for screen filename.
returns
|
(ret)
|
|
ret
|
Color table for screen filename.
|
GetColorTablePlot ()
Returns the color table for plotting filename.
returns
|
(ret)
|
|
ret
|
Color table for plotting filename.
|
GetColorTableOverride ()
Returns the color table override filename.
returns
|
(ret)
|
|
ret
|
color table override filename.
|
GetLayerNameFile ()
Returns name of file containing layer names.
returns
|
(ret)
|
|
ret
|
Name of file containing layer names.
|
GetPenTable ()
Returns the pen table filename.
returns
|
(ret)
|
|
ret
|
Pen table filename.
|
SetPenTable (FileName)
Sets the pen table filename.
FileName
|
Pen table filename.
|
GetUsePenTable ()
Gets status of pen table usage.
returns
|
(ret)
|
|
ret
|
0=Pen table not being used, 1=Pen table being used.
|
GetBackgroundColor ()
Returns current background color.
returns
|
(ret)
|
|
ret
|
Background color (1-255)
|
GetSeaRad ()
Returns current search radius.
returns
|
(ret)
|
|
ret
|
Current search radius.
|
GetSeaDim ()
Returns current search dimension.
returns
|
(ret)
|
|
ret
|
Current search dimension.
|
GetSplineChord ()
Returns the spline chord length in in. or mm.
GetBSplineIncr ()
Returns the B-Spline increment
GetStrokeDist ()
Returns the stroke distance for wide lines.
GetStrokeMode ()
Returns the stroke mode for wide line.
GetFillDist ()
Returns the fill distance for wide lines.
GetMinTextSize ()
Returns the minimum text size for plotting.
GetMinSymSize ()
Returns the minimum symbol size for plotting.
GetMbrOffset ()
Returns the default MBR offset
SetDspLines (DspLines)
Sets the display line status.
DspLines
|
0=Don't display lines, 1=Display lines
|
GetDspLines ()
Gets the display line status.
returns
|
(ret)
|
|
ret
|
0=Don't display lines, 1=Display lines
|
SetDspSplines (DspSplines)
Sets the display splined line status.
DspSplines
|
0=Don't display splined lines, 1=Display splined lines
|
GetDspSplines ()
Gets the display splined line status.
returns
|
(ret)
|
|
ret
|
0=Don't display splined lines, 1=Display splined lines
|
SetDspLfonts (DspLfonts)
Sets the display line fonts status.
DspLfonts
|
0=Don't display line fonts, 1=Display line fonts
|
GetDspLfonts ()
Gets the display line fonts status.
returns
|
(ret)
|
|
ret
|
0=Don't display line fonts, 1=Display line fonts
|
SetDspConstr (DspConstr)
Sets the display construction lines status.
DspConstr
|
0=Don't display construction line, 1=Display construction lines
|
GetDspConstr ()
Gets the display construction lines status.
returns
|
(ret)
|
|
ret
|
0=Don't display construction line, 1=Display construction lines
|
SetDspLinePoints (DspLinePoints)
Sets the display line points flag.
DspLinePoints
|
0=Don't display line points, 1=Display line points
|
GetDspLinePoints ()
Gets the display line points flag.
returns
|
(ret)
|
|
ret
|
0=Don't display line points, 1=Display line points
|
SetDspLineElevs (DspLineElevs)
Sets the display line elevations flag.
DspLineElevs
|
0=Don't display line elevations, 1=Display line elevations
|
GetDspLineElevs ()
Gets the display line points flag.
returns
|
(ret)
|
|
ret
|
0=Don't display line elevations, 1=Display line elevations
|
SetDspSymbols (DspSymbols)
Sets the display symbols flag.
DspSymbols
|
0=Don't display symbols, 1=Display symbols
|
GetDspSymbols ()
Gets the display symbols flag.
returns
|
(ret)
|
|
ret
|
0=Don't display symbols, 1=Display symbols
|
SetDspText (DspText)
Sets the display text flag.
DspText
|
0=Don't display text, 1=Display text
|
GetDspText ()
Gets the display text flag.
returns
|
(ret)
|
|
ret
|
0=Don't display text, 1=Display text
|
SetDspILines (DspILines)
Sets the display interactive lines flag.
DspILines
|
0=Don't display interactive lines, 1=Display interactive lines
|
GetDspILines ()
Gets the display interactive lines flag.
returns
|
(ret)
|
|
ret
|
0=Don't display interactive lines, 1=Display interactive lines
|
SetDspISymbols (DspISymbols)
Sets the display interactive symbols flag.
DspISymbols
|
0=Don't display interactive symbols, 1=Display interactive symbols
|
GetDspISymbols ()
Gets the display interactive symbols flag.
returns
|
(ret)
|
|
ret
|
0=Don't display interactive symbols, 1=Display interactive symbols
|
SetDspIText (DspIText)
Sets the display interactive text flag.
DspIText
|
0=Don't display interactive text, 1=Display interactive text
|
GetDspIText ()
Gets the display interactive text flag.
returns
|
(ret)
|
|
ret
|
0=Don't display interactive text, 1=Display interactive text
|
SetMbrOffset (Offset)
Sets the entity MBR offset used when searching.
SetColorTableOverride (ColorTableName)
Sets the color table override filename.
ColorTableName
|
Color table override filename
|
SetSplineChord (SplineChord)
Sets the spline chord length.
SplineChord
|
Spline chord length (in|mm) It is expected that the parameter is in the proper units (inches or millimeter).
|
SetBSplineIncr (BSplineIncr)
Sets the B spline increment. Sets the number of points that will be added between current points.
SetCursorType (CursorType)
Sets the cursor type.
GetCursorType ()
Returns the cursor type.
returns
|
(ret)
|
|
ret
|
0=Cross 1=Dot
|
SetCursorSize (CursorSize)
Sets the cursor size.
CursorSize
|
Cursor size in pixels
|
GetCursorSize ()
Returns the cursor size in pixels.
returns
|
(ret)
|
|
ret
|
Cursor size in pixels
|
SetCursorColor (CursorColor)
Sets the cursor color.
CursorColor
|
0=White 1=Black 2=Red 3=Green 4=Blue 5=Yellow
|
GetCursorColor ()
Gets the cursor color.
returns
|
(ret)
|
|
ret
|
0=White 1=Black 2=Red 3=Green 4=Blue 5=Yellow
|
SetCursorMaskSize (CursorSize)
Sets the cursor mask size.
CursorSize
|
Cursor mask size in pixels
|
GetCursorMaskSize ()
Gets the cursor mask size.
returns
|
(ret)
|
|
ret
|
Cursor mask size in pixels
|
SetCursorMaskShape (CursorShape)
Sets the cursor mask shape.
CursorShape
|
0=Square,1=Circle
|
GetCursorMaskShape ()
Gets the cursor mask shape.
returns
|
(ret)
|
|
ret
|
0=Square,1=Circle
|
SetCursorTrackPlane (TrackPlane)
Sets the cursor track plane for VrTwo.
TrackPlane
|
0=VIEW_PLANE 1=GROUND_PLANE
|
GetCursorTrackPlane ()
Gets the cursor track plane for VrTwo.
returns
|
(ret)
|
|
ret
|
0=VIEW_PLANE 1=GROUND_PLANE
|
GetImgPyraDir ()
Returns the image pyramid directory.
GetImgPyraDrive ()
Returns the image pyramid drive.
TogImgEdges ()
Toggles the display of image edges/names (Mono view only).
SetImgEdges (ImgEdges)
Sets the image edge display flag.
ImgEdges
|
0=Don't display image edges, 1=Display image edges
|
GetImgEdges ()
Gets the image edge display flag.
returns
|
(ret)
|
|
ret
|
0=Don't display image edges, 1=Display image edges
|
TogImgNames ()
Toggles the display of image edges/names (mono view only).
SetImgNames (ImgNames)
Sets the image edge display flag.
ImgNames
|
0=Don't display image names, 1=Display image names
|
GetImgNames ()
Gets the image edge display flag.
returns
|
(ret)
|
|
ret
|
0=Don't display image names, 1=Display image names
|
SetImgDrawMode (DrawMode)
Sets image draw mode.
DrawMode
|
1=Draw, 3=Xor, 4=Or
|
GetImgDrawMode ()
Gets image draw mode.
returns
|
(ret)
|
|
ret
|
1=Draw, 3=Xor, 4=Or
|
GetWinShift ()
Gets Window shift flag.
returns
|
(ret)
|
|
ret
|
0=Window shifting off, 1=Window shifting on
|
SetWinShift (WinShift)
Sets Window shift flag.
WinShift
|
0=Window shifting off, 1=Window shifting on
|
SetBufXyXyzInput (BufMode)
Sets input buffering flag.
GetBufXyXyzInput ()
Gets input buffering flag.
returns
|
(ret)
|
|
ret
|
0=Off, 1=On
|
SetWinSync (WinSync)
Sets window synchronization flag.
GetWinSync ()
Gets window synchronization flag.
returns
|
(ret)
|
|
ret
|
0=Off, 1=On
|
SetGridStus (GridStus)
Sets grid display flag.
GetGridStus ()
Gets grid display flag.
returns
|
(ret)
|
|
ret
|
0=Off, 1=On
|
SetGridRes (GridRes)
Sets grid resolution.
GetGridRes ()
Gets grid resolution.
SetGridType (GridType)
Sets grid type.
GridType
|
0=Points, 1=Lines
|
GetGridType ()
Gets grid type.
returns
|
(ret)
|
|
ret
|
0=Points, 1=Lines
|
SuspendGrid ()
Suspends grid display point snapping.
ResumeGrid ()
Resumes grid display point snapping.
SetCursConstStus (CursConstStus)
Sets cursor constraint mode flag.
CursConstStus
|
0=Off, 1=On
|
GetCursConstStus ()
Gets cursor constraint mode flag.
returns
|
(ret)
|
|
ret
|
0=Off, 1=On
|
TogCursConstStus ()
Toggles cursor constraint flag.
GetXyDigId ()
Gets the XY Digitizer ID.
SetXyDigId (XyDigId)
Sets the XY Digitizer ID.
GetXyDigDelay ()
Gets XY Digitizer delay.
GetXyDigMode ()
Gets XY Digitizer mode.
GetXyzDigId ()
Gets the XYZ Digitizer ID.
SetXyzDigId (XyzDigId)
Sets the XYZ Digitizer ID.
GetXyzDigDelay ()
Gets the XYZ digitizer delay amount.
SetVrTwoWake (WakeMode)
Sets VrTwo wake mode.
WakeMode
|
0=Static, 1=Roaming
|
GetVrTwoWake ()
Gets VrTwo wake mode.
returns
|
(ret)
|
|
ret
|
0=Static, 1=Roaming
|
SetVrTwoEdgeDist (EdgeDist)
Sets VrTwo edge distance.
GetVrTwoEdgeDist ()
Gets VrTwo edge distance.
SetHwId (HwId)
Sets handwheel ID.
GetHwId ()
Gets handwheel ID.
SetHwSfX (HwSfX)
Sets handweel X scale factor.
GetHwSfX ()
Gets handweel X scale factor.
SetHwSfY (HwSfY)
Sets handweel Y scale factor.
GetHwSfY ()
Gets handweel Y scale factor.
SetHwSfZ (HwSfZ)
Set handweel Z scale factor.
GetHwSfZ ()
Gets handweel Z scale factor.
SetHwLocZ (HwLocZ)
Sets handweel Z location.
HwLocZ
|
0=Normal, 1=Z on right handwheel, 2=Z on left handwheel
|
GetHwLocZ ()
Gets handweel Z location.
returns
|
(ret)
|
|
ret
|
0=Normal, 1=Z on right handwheel, 2=Z on left handwheel
|
SetMouseTwSf (Sf)
Sets the Mouse thumbwheel Scale Factor.
GetMouseTwSf ()
Returns the Mouse thumbwheel Scale Factor.
SetMouseKeyX (RawKey, KeyX)
Sets a mouse key cross-reference.
RawKey
|
Raw key value (1-16)
|
KeyX
|
Key cross-reference value
|
GetMouseKeyX (RawKey)
Gets the cross-reference value for a mouse key.
RawKey
|
Mouse raw device (1-16)
|
returns
|
(ret)
|
|
ret
|
Cross-referenced key value
|
SetZSource (ZSource)
Sets Z source.
ZSource
|
0=Instrument or Active Z, 1=Dtm Z if active, 2=Force Z
|
GetZSource ()
Gets Z source.
returns
|
(ret)
|
|
ret
|
0=Instrument or Active Z, 1=Dtm Z if active, 2=Force Z
|
SetActiveZ (ActiveZ)
Sets active Z.
GetActiveZ ()
Gets active Z.
IncActiveZ (DeltaZ)
Increments active Z.
GetForceZ ()
Gets force Z flag.
returns
|
(ret)
|
|
ret
|
0=On, 1=Off
|
SetForceZ (ForceZ)
Sets force Z flag.
GetContInt ()
Gets contour interval.
SetContInt (ContInt)
Sets contour interval.
GetSnapZToActiveZ ()
Gets snap z to active z flag.
returns
|
(ret)
|
|
ret
|
0=On, 1=Off
|
SetSnapZToActiveZ (SnapZToActiveZ)
Sets snap z to active z flag.
SnapZToActiveZ
|
0=On, 1=Off
|
SetPlotFormat (PlotFormat)
Sets the plot format.
PlotFormat
|
0=HPGL 1=HPGL2 2=HPGL2/RTL 3=POSTSCRIPT
|
GetPlotFormat ()
Sets the plot format.
returns
|
(ret)
|
|
ret
|
0=HPGL 1=HPGL2 2=HPGL2/RTL 3=POSTSCRIPT
|
GetPlotIface ()
Gets plot interface.
returns
|
(ret)
|
|
ret
|
0=TO_FILE 1=TO_RS232
|
GetPlotBrightContrast ()
Gets the plotter brightness and contrast adjustments.
returns
|
(Bright, Contrast)
|
|
Bright
|
Brightness adjustment 0-100 (50=none)
|
|
Contrast
|
Contrast adjustment 0-100 (50=none)
|
SetPlotBrightContrast (Bright, Contrast)
Sets the plotter brightness and contrast adjustments.
Bright
|
Brightness adjustment 0-100 (50=none)
|
Contrast
|
Contrast adjustment 0-100 (50=none)
|
GetVrPathDir (DirNum)
Returns a Vr path directory name.
DirNum
|
Directory number (0-9)
|
returns
|
(DirName)
|
|
DirName
|
Return directory name (128 char)
|
SetVrPathDir (DirNum, DirName)
Sets a Vr path directory name.
DirNum
|
Directory number (0-9)
|
DirName
|
Return directory name (128 char)
|
GetActiveDig ()
Gets digitizer used when starting VrOne.
returns
|
(ret)
|
|
ret
|
0 = XY, 1 - XYZ, 2 - Mouse
|
GetOpenLastVr ()
Gets Open last VR files flag.
returns
|
(ret)
|
|
ret
|
0=No 1=Yes
|
GetOpenLastImg ()
Gets Open last Image files flag.
returns
|
(ret)
|
|
ret
|
0=No 1=Yes
|
GetPromptUnits ()
Gets prompt units.
returns
|
(ret)
|
|
ret
|
0=Inches 1=Millimeters
|
GetMaxApps ()
Gets the maximum number of VrOne applications.
SetMwDecAccur (DecAccur)
Sets main window decimal accuracy.
DecAccur
|
Decimal accuracy for coords in main window.
|
GetMwDecAccur ()
Gets main window decimal accuracy.
GetMmPerInch ()
Gets the number of millimeters per inch.
returns
|
(ret)
|
|
ret
|
Number of mm per inch i.e. 25.4
|
GetMetersToFeet ()
Gets the meters to feet conversion factor.
GetBrowser ()
Gets the browser program file name.
GetFkeyFileName ()
Gets the function key file name.
GetMbCmdFileName ()
Gets the XYZ digitizer menu board command file name.
GetKpCmdFileName ()
Gets the keypad menu board command file name.
GetMacroFileName ()
Gets current macro filename.
SetBeepStus (BeepStus)
Sets beep flag.
GetBeepStus ()
Gets beep flag.
returns
|
(ret)
|
|
ret
|
0=On, 1=Off
|
GetBeep (ButtonNum)
Gets the button status for a single button.
ButtonNum
|
Button number 0-11 (10=* 11=#)
|
SetBeep (ButtonNum, BeepStatus)
Sets the button status for a single button.
ButtonNum
|
Button number 0-11 (10=* 11=#)
|
BeepStatus
|
0=Off 1=On
|
SetBeep2 (BeepStatus)
Sets the button status for all buttons.
GetBeepSound (ButtonNum)
Gets the sound file name for a beep.
ButtonNum
|
ButtonNum 0-11 (10=* 11=#)
|
returns
|
(BeepSound)
|
|
BeepSound
|
Sound file name (128 char, Normally .wav)
|
SetBeepSound (ButtonNum, BeepSound)
Sets the sound file name for a beep.
ButtonNum
|
ButtonNum 0-11 (10=* 11=#)
|
BeepSound
|
Sound file name (128 char, Normally .wav)
|
SetBeepNormal (BeepSound)
Sets the normal beep sound.
BeepSound
|
Sound file name (128 char, Normally .wav)
|
GetBeepNormal ()
Gets the normal beep sound.
returns
|
(ret)
|
|
ret
|
Sound file name (128 char, Normally .wav)
|
SetBeepAlert (BeepSound)
Sets the normal beep sound.
BeepSound
|
Sound file name (128 char, Normally .wav)
|
GetBeepAlert ()
Gets the normal beep sound.
returns
|
(ret)
|
|
ret
|
Sound file name (128 char, Normally .wav)
|
SetBeepPlotStart (BeepSound)
Sets the sound of the beep when replot is started.
BeepSound
|
Sound file name (128 char, Normally .wav)
|
GetBeepPlotStart ()
Gets the sound of the beep when replot is started.
returns
|
(ret)
|
|
ret
|
Sound file name (128 char, Normally .wav)
|
SetBeepPlotDone (BeepSound)
Sets the sound of the beep when replot is done.
BeepSound
|
Sound file name (128 char, Normally .wav)
|
GetBeepPlotDone ()
Gets the sound of the beep when replot is done.
returns
|
(ret)
|
|
ret
|
Sound file name (128 char, Normally .wav)
|
SetNumLockControl (State)
Sets num lock control flag.
GetNumLockControl ()
Gets num lock control flag.
returns
|
(ret)
|
|
ret
|
0=On, 1=Off
|
|