VrOne/Python Programming

ON-LINE REFERENCE DOCUMENTATION CARDINAL SYSTEMS, LLC 386-439-2525 www.cardinalsystems.net

VrLayer Class Reference

VrOne/Python Layer Class More...

Members

• Stat (Layer)
• Cond (Layer, OnOff)
• CondNumLine (LayerStrg, OnOff)
• AllOn ()
• AllOff ()
• LoadNames (FileName)
• RecNames (FileName)
• GetNameCount ()
• ResetNameCount ()
• AddName (Layer, Name, Prop, Desc)
• GetName (Layer)
• GetNameByIdx (Index)
• Print ()

---

Detailed Description

Allows layer settings to be viewed and changed, and contains methods for dealing with layer names.

Example:

from pylayer import *

Layer = VrLayer ()

(VrVersion) = Cfg.GetVrVersion ()

---

Member Function Documentation

Stat (Layer)

Returns status of layer sent

Layer	Layer number.
returns	(ret)
	ret	0 - Layer is off 1 - Layer is on

Cond (Layer, OnOff)

Conditions a single layer

Layer	Layer number.
OnOff	0 - Turn layer off 1 - Turn layer on 2 - Turn this layer off. Turn all others on. 3 - Turn this layer on. Turn all others off.

CondNumLine (LayerStrg, OnOff)

Conditions a group of layers based on a number line

LayerStrg	Number line containing layers
OnOff	0 - Turn layers off 1 - Turn layers on 2 - Turn these layers off. Turn all others on. 3 - Turn these layers on. Turn all others off.

AllOn ()

Turns all layers on

AllOff ()

Turns all layers off

LoadNames (FileName)

Loads layer names from disk.

FileName

Layer name file name.

RecNames (FileName)

Loads layer names from disk.

FileName

Layer name file name.

GetNameCount ()

Returns the current number of layer names used.

ResetNameCount ()

Returns the current number of layer names used.

AddName (Layer, Name, Prop, Desc)

Adds a layer name.

Layer	Layer number (1-MAXLAYERS)
Name	Layer name to set (32 char)
Prop	Layer property (32 char) (optional)
Desc	Layer description (64 char) (optional)

GetName (Layer)

Gets a layer name.

Layer	Layer number (1-MAXLAYERS)
returns	(Name, Prop, Desc)
	Name	Return layer name (32 char)
	Prop	Return layer property (32 char) (optional)
	Desc	Return layer description (64 char) (optional)

GetNameByIdx (Index)

Gets a layer number and name by index.

Index	Index 0-GetNameCount()-1
returns	(Layer, Name, Prop, Desc)
	Layer	Return layer number (1-MAXLAYERS)
	Name	Return layer name (32 char)
	Prop	Return layer property (32 char) (optional)
	Desc	Return layer description (64 char) (optional)

Print ()

Prints current layer table