instructions.InstructionObject Class Reference

Abtract class representing single instruction. More...

Inheritance diagram for instructions.InstructionObject:

Public Member Functions
def	__init__
def	__str__
	Returns particular part of text instruction.
def	__getitem__
def	__setitem__
def	GetInstruction
	Get current values.
def	SetInstruction
	Set default values.
def	Read
	Read instruction and save them.
def	PercentToReal
	Converts text coordinates from percent of region to map coordinates.
Data Fields
	id
	defaultInstruction
	instruction
	unitConv

---

Detailed Description

Abtract class representing single instruction.

Definition at line 469 of file instructions.py.

---

Constructor & Destructor Documentation

def instructions.InstructionObject.__init__	(		self,
			id
	)

Reimplemented in instructions.Vector, instructions.Raster, instructions.VectorLegend, instructions.RasterLegend, instructions.Scalebar, instructions.Rectangle, instructions.Line, instructions.Point, instructions.Text, instructions.Mapinfo, instructions.PageSetup, instructions.MapFrame, and instructions.InitMap.

Definition at line 471 of file instructions.py.

---

Member Function Documentation

def instructions.InstructionObject.__getitem__	(		self,
			key
	)

Definition at line 485 of file instructions.py.

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

def instructions.InstructionObject.__setitem__	(		self,
			key,
			value
	)

Definition at line 491 of file instructions.py.

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

def instructions.InstructionObject.__str__

(

self

)

Returns particular part of text instruction.

Reimplemented in instructions.VProperties, instructions.Vector, instructions.Raster, instructions.VectorLegend, instructions.RasterLegend, instructions.Scalebar, instructions.Rectangle, instructions.Line, instructions.Point, instructions.NorthArrow, instructions.Image, instructions.Text, instructions.Mapinfo, instructions.PageSetup, and instructions.MapFrame.

Definition at line 481 of file instructions.py.

def instructions.InstructionObject.GetInstruction

(

self

)

Get current values.

Definition at line 494 of file instructions.py.

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

def instructions.InstructionObject.PercentToReal	(		self,
			e,
			n
	)

Converts text coordinates from percent of region to map coordinates.

Definition at line 506 of file instructions.py.

Referenced by instructions.Text.Read(), instructions.Image.Read(), instructions.Point.Read(), instructions.Line.Read(), and instructions.Rectangle.Read().

def instructions.InstructionObject.Read	(		self,
			instruction,
			text,
			kwargs
	)

Read instruction and save them.

Reimplemented in instructions.VProperties, instructions.Vector, instructions.VectorLegend, instructions.RasterLegend, instructions.Scalebar, instructions.Rectangle, instructions.Line, instructions.Point, instructions.Image, instructions.Text, instructions.PageSetup, and instructions.MapFrame.

Definition at line 502 of file instructions.py.

def instructions.InstructionObject.SetInstruction	(		self,
			instruction
	)

Set default values.

Definition at line 498 of file instructions.py.

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

---

Field Documentation

instructions.InstructionObject.defaultInstruction

Reimplemented in instructions.VProperties, instructions.Vector, instructions.Raster, instructions.VectorLegend, instructions.RasterLegend, instructions.Scalebar, instructions.Rectangle, instructions.Line, instructions.Point, instructions.Image, instructions.Text, instructions.Mapinfo, instructions.PageSetup, instructions.MapFrame, and instructions.InitMap.

Definition at line 475 of file instructions.py.

instructions.InstructionObject.id

Definition at line 472 of file instructions.py.

instructions.InstructionObject.instruction

Reimplemented in instructions.VProperties, instructions.Vector, instructions.Raster, instructions.VectorLegend, instructions.RasterLegend, instructions.Scalebar, instructions.Rectangle, instructions.Line, instructions.Point, instructions.Image, instructions.Text, instructions.Mapinfo, instructions.PageSetup, instructions.MapFrame, and instructions.InitMap.

Definition at line 477 of file instructions.py.

Referenced by instructions.InstructionObject.__getitem__(), instructions.InstructionObject.__setitem__(), 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.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.InstructionObject.unitConv

Definition at line 479 of file instructions.py.

---

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

• instructions.py