GRASS Programmer's Manual  6.4.4(2014)-r
instructions.Instruction Class Reference

Class which represents instruction file. More...

Public Member Functions

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

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.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.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 
)
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.objectsToDraw

Definition at line 53 of file instructions.py.

Referenced by instructions.Instruction.__delitem__().


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