rtshell.port_types.PortSpec Class Reference

Class for managing port specifications. More...

List of all members.

Public Member Functions
def	__init__
def	__str__
def	add_target
def	formatter
def	input
def	name
def	output
def	raw
def	targets
def	type
def	type_name
Private Attributes
	_formatter
	_input
	_name
	_raw_specs
	_targets
	_type
	_type_name

---

Detailed Description

Class for managing port specifications.

Definition at line 33 of file port_types.py.

---

Constructor & Destructor Documentation

def rtshell.port_types.PortSpec.__init__	(		self,
			name,
			type,
			target,
			input = True,
			formatter = None,
			type_name = '',
			raw = '',
			args,
			kwargs
	)

Definition at line 34 of file port_types.py.

---

Member Function Documentation

def rtshell.port_types.PortSpec.__str__

(

self

)

Definition at line 45 of file port_types.py.

def rtshell.port_types.PortSpec.add_target	(		self,
			target,
			raw = ''
	)

Add an additional target for this port.

Definition at line 96 of file port_types.py.

def rtshell.port_types.PortSpec.formatter

(

self

)

Get the port's formatter function.

Definition at line 57 of file port_types.py.

def rtshell.port_types.PortSpec.input

(

self

)

If the port is an input port or not.

Definition at line 62 of file port_types.py.

def rtshell.port_types.PortSpec.name

(

self

)

The name of the port.

Definition at line 67 of file port_types.py.

def rtshell.port_types.PortSpec.output

(

self

)

If the port is an output port or not.

Definition at line 72 of file port_types.py.

def rtshell.port_types.PortSpec.raw

(

self

)

The raw port specifications that created this PortSpec.

Definition at line 77 of file port_types.py.

def rtshell.port_types.PortSpec.targets

(

self

)

The target ports of this port, as [(path, port_name), ...].

Definition at line 82 of file port_types.py.

def rtshell.port_types.PortSpec.type

(

self

)

The port's data type constructor function.

Definition at line 87 of file port_types.py.

def rtshell.port_types.PortSpec.type_name

(

self

)

The port's data type name.

Definition at line 92 of file port_types.py.

---

Member Data Documentation

rtshell::port_types.PortSpec::_formatter [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_input [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_name [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_raw_specs [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_targets [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_type [private]

Definition at line 34 of file port_types.py.

rtshell::port_types.PortSpec::_type_name [private]

Definition at line 34 of file port_types.py.

---

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

• port_types.py