rtshell.gen_comp.Port Class Reference

Port class. More...

List of all members.

Public Member Functions
def	__init__
def	data
def	format
def	formatter
def	name
def	port
def	raw
def	read
def	standard_type
Private Attributes
	_data
	_formatter
	_port
	_raw
	_standard_type

---

Detailed Description

Port class.

Class to store the objects used for a port.

Definition at line 32 of file gen_comp.py.

---

Constructor & Destructor Documentation

def rtshell.gen_comp.Port.__init__	(		self,
			data,
			port,
			formatter = None,
			raw_spec = None,
			args,
			kwargs
	)

Definition at line 34 of file gen_comp.py.

---

Member Function Documentation

def rtshell.gen_comp.Port.data

(

self

)

Get the port's data reference.

Definition at line 49 of file gen_comp.py.

def rtshell.gen_comp.Port.format

(

self

)

Return a string representation of the value of self.data.

If self.formatter is not None, that function will be called to create
the string representation. Otherwise, str() will be used except in the
cases of data that contains a .tm member of type RTC.Time and a .data
member. In that case, the time will be pretty-printed, followed by the
data member, printed using str().

Definition at line 87 of file gen_comp.py.

def rtshell.gen_comp.Port.formatter

(

self

)

Get the formatter function for the port, if any.

Definition at line 59 of file gen_comp.py.

def rtshell.gen_comp.Port.name

(

self

)

Get the port's name.

Definition at line 64 of file gen_comp.py.

def rtshell.gen_comp.Port.port

(

self

)

Get the port object.

Definition at line 54 of file gen_comp.py.

def rtshell.gen_comp.Port.raw

(

self

)

Get the raw port spec for this port, if any.

Definition at line 69 of file gen_comp.py.

def rtshell.gen_comp.Port.read

(

self

)

Read the next value from the port into self.data.

Definition at line 83 of file gen_comp.py.

def rtshell.gen_comp.Port.standard_type

(

self

)

Check if the port's data type is an RTC standard type.

RTC standard types have a tm member (the timestamp) and a data member
(the data).

Definition at line 74 of file gen_comp.py.

---

Member Data Documentation

rtshell::gen_comp.Port::_data [private]

Definition at line 34 of file gen_comp.py.

rtshell::gen_comp.Port::_formatter [private]

Definition at line 34 of file gen_comp.py.

rtshell::gen_comp.Port::_port [private]

Definition at line 34 of file gen_comp.py.

rtshell::gen_comp.Port::_raw [private]

Definition at line 34 of file gen_comp.py.

rtshell::gen_comp.Port::_standard_type [private]

Definition at line 34 of file gen_comp.py.

---

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

• gen_comp.py