Public Member Functions | Public Attributes | Private Attributes | List of all members
rtsprofile.location.Location Class Reference

Location object. More...

Inheritance diagram for rtsprofile.location.Location:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, x=0, y=0, height=0, width=0, direction=dir.DOWN)
 
def __str__ (self)
 
def direction (self)
 
def direction (self, direction)
 
def height (self)
 
def height (self, height)
 
def parse_xml_node (self, node)
 
def parse_yaml (self, y)
 
def save_xml (self, doc, element)
 
def to_dict (self)
 
def width (self)
 
def width (self, width)
 
def x (self)
 
def x (self, x)
 
def y (self)
 
def y (self, y)
 

Public Attributes

 direction
 
 height
 
 width
 
 x
 
 y
 

Private Attributes

 _direction
 
 _height
 
 _width
 
 _x
 
 _y
 

Detailed Description

Location object.

Stores the location of a component in a graphical view.

Definition at line 34 of file location.py.

Constructor & Destructor Documentation

def rtsprofile.location.Location.__init__ (   self,
  x = 0,
  y = 0,
  height = 0,
  width = 0,
  direction = dir.DOWN 
)
Constructor.

@param x X position of the top-left of the component.
@type x int
@param y Y position of the top-left of the component.
@type y int
@param height Height of the component.
@type height int
@param width Width of the component.
@type width int
@param direction Direction the component faces.
@type direction direction.const_type

Definition at line 37 of file location.py.

Member Function Documentation

def rtsprofile.location.Location.__str__ (   self)

Definition at line 68 of file location.py.

def rtsprofile.location.Location.direction (   self)
The direction of the component in a graphical tool.

A value of -1 for this property indicates that the height should be as
wide as is necessary.

Definition at line 123 of file location.py.

def rtsprofile.location.Location.direction (   self,
  direction 
)

Definition at line 133 of file location.py.

def rtsprofile.location.Location.height (   self)
The height of the component in a graphical tool.

Definition at line 96 of file location.py.

def rtsprofile.location.Location.height (   self,
  height 
)

Definition at line 101 of file location.py.

def rtsprofile.location.Location.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a location into this
object.

Definition at line 138 of file location.py.

def rtsprofile.location.Location.parse_yaml (   self,
  y 
)
Parse a YAML specification of a location into this object.

Definition at line 151 of file location.py.

def rtsprofile.location.Location.save_xml (   self,
  doc,
  element 
)
Save this location into an xml.dom.Element object.

Definition at line 160 of file location.py.

def rtsprofile.location.Location.to_dict (   self)
Save this location into a dictionary.

Definition at line 171 of file location.py.

def rtsprofile.location.Location.width (   self)
The width of the component in a graphical tool.

A value of -1 for this property indicates that the width should be as
wide as is necessary.

Definition at line 107 of file location.py.

def rtsprofile.location.Location.width (   self,
  width 
)

Definition at line 117 of file location.py.

def rtsprofile.location.Location.x (   self)
The X position of the component in a graphical tool.

Definition at line 74 of file location.py.

def rtsprofile.location.Location.x (   self,
  x 
)

Definition at line 79 of file location.py.

def rtsprofile.location.Location.y (   self)
The Y position of the component in a graphical tool.

Definition at line 85 of file location.py.

def rtsprofile.location.Location.y (   self,
  y 
)

Definition at line 90 of file location.py.

Member Data Documentation

rtsprofile.location.Location._direction
private

Definition at line 66 of file location.py.

rtsprofile.location.Location._height
private

Definition at line 60 of file location.py.

rtsprofile.location.Location._width
private

Definition at line 63 of file location.py.

rtsprofile.location.Location._x
private

Definition at line 54 of file location.py.

rtsprofile.location.Location._y
private

Definition at line 57 of file location.py.

rtsprofile.location.Location.direction

Definition at line 147 of file location.py.

rtsprofile.location.Location.height

Definition at line 145 of file location.py.

rtsprofile.location.Location.width

Definition at line 146 of file location.py.

rtsprofile.location.Location.x

Definition at line 143 of file location.py.

rtsprofile.location.Location.y

Definition at line 144 of file location.py.


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


rtsprofile
Author(s): Geoffrey Biggs
autogenerated on Fri Jun 7 2019 21:52:35