instructions.Instruction Class Reference

Class which represents instruction file. More...

Public Member Functions
def	__init__
def	__str__
	Returns text for instruction file.
def	__getitem__
def	__contains__
	Test if instruction is included.
def	__delitem__
	Delete instruction.
def	AddInstruction
	Add instruction.
def	FindInstructionByType
	Find instruction(s) with the given type.
def	Read
	Reads instruction file and creates instruction objects.
def	SendToRead
def	SetRegion
	Sets region from file comment or sets current region in case of no comment.
Data Fields
	parent
	objectsToDraw
	instruction
	filename

---

Detailed Description

Class which represents instruction file.

Definition at line 48 of file instructions.py.

---

Constructor & Destructor Documentation

def instructions.Instruction.__init__	(		self,
			parent,
			objectsToDraw
	)

Definition at line 50 of file instructions.py.

---

Member Function Documentation

def instructions.Instruction.__contains__	(		self,
			id
	)

Test if instruction is included.

Definition at line 76 of file instructions.py.

References instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, and dialogs.LegendDialog.instruction.

def instructions.Instruction.__delitem__	(		self,
			id
	)

Delete instruction.

Definition at line 83 of file instructions.py.

References instructions.Instruction.FindInstructionByType(), instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, dialogs.LegendDialog.instruction, and instructions.Instruction.objectsToDraw.

def instructions.Instruction.__getitem__	(		self,
			id
	)

Definition at line 70 of file instructions.py.

References instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, and dialogs.LegendDialog.instruction.

def instructions.Instruction.__str__

(

self

)

Returns text for instruction file.

Definition at line 57 of file instructions.py.

References instructions.Instruction.FindInstructionByType(), instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, dialogs.LegendDialog.instruction, and localtime().

def instructions.Instruction.AddInstruction	(		self,
			instruction
	)

Add instruction.

Definition at line 101 of file instructions.py.

Referenced by instructions.Instruction.SendToRead(), and instructions.Instruction.SetRegion().

def instructions.Instruction.FindInstructionByType	(		self,
			type,
			list = False
	)

Find instruction(s) with the given type.

Definition at line 116 of file instructions.py.

References instructions.Instruction.instruction, frame.PsMapFrame.instruction, dialogs.PsmapDialog.instruction, dialogs.MapFramePanel.instruction, frame.PsMapBufferedWindow.instruction, dialogs.RasterPanel.instruction, dialogs.VectorPanel.instruction, and dialogs.LegendDialog.instruction.

Referenced by instructions.Instruction.__delitem__(), instructions.Instruction.__str__(), and instructions.Instruction.SendToRead().

def instructions.Instruction.Read	(		self,
			filename
	)

Reads instruction file and creates instruction objects.

Definition at line 126 of file instructions.py.

def instructions.Instruction.SendToRead	(		self,
			instruction,
			text,
			kwargs
	)

Definition at line 359 of file instructions.py.

References instructions.Instruction.AddInstruction(), and instructions.Instruction.FindInstructionByType().

def instructions.Instruction.SetRegion	(		self,
			regionInstruction
	)

Sets region from file comment or sets current region in case of no comment.

Definition at line 430 of file instructions.py.

References instructions.Instruction.AddInstruction(), utils.CmdToTuple(), utils.GetCmdString(), gcmd.RunCommand(), and utils.split().

---

Field Documentation

instructions.Instruction.filename

Definition at line 128 of file instructions.py.

instructions.Instruction.instruction

Definition at line 55 of file instructions.py.

Referenced by instructions.Instruction.__contains__(), instructions.Instruction.__delitem__(), instructions.Instruction.__getitem__(), instructions.InstructionObject.__getitem__(), instructions.InstructionObject.__setitem__(), instructions.Instruction.__str__(), instructions.MapFrame.__str__(), instructions.PageSetup.__str__(), instructions.Mapinfo.__str__(), instructions.Text.__str__(), instructions.Image.__str__(), instructions.NorthArrow.__str__(), instructions.Point.__str__(), instructions.Line.__str__(), instructions.Rectangle.__str__(), instructions.Scalebar.__str__(), instructions.RasterLegend.__str__(), instructions.VectorLegend.__str__(), instructions.Raster.__str__(), instructions.VProperties.__str__(), instructions.Image.ChangeRefPoint(), instructions.Instruction.FindInstructionByType(), instructions.InstructionObject.GetInstruction(), instructions.MapFrame.Read(), instructions.Mapinfo.Read(), instructions.Image.Read(), instructions.Point.Read(), instructions.Line.Read(), instructions.Rectangle.Read(), instructions.Scalebar.Read(), instructions.Vector.Read(), and instructions.InstructionObject.SetInstruction().

instructions.Instruction.objectsToDraw

Definition at line 53 of file instructions.py.

Referenced by instructions.Instruction.__delitem__().

instructions.Instruction.parent

Definition at line 52 of file instructions.py.

Referenced by wxdigit.VDigitError.Database(), wxdigit.VDigitError.DbExecute(), wxdigit.VDigitError.DbLink(), wxdigit.VDigitError.DeadLine(), wxdigit.VDigitError.Driver(), wxdigit.VDigitError.FeatureType(), wxdigit.VDigitError.NoMap(), wxdigit.VDigitError.ReadLine(), and wxdigit.VDigitError.WriteLine().

---

The documentation for this class was generated from the following file:

• instructions.py