grc.elements.Platform.Platform Class Reference

List of all members.

Public Member Functions
def	__init__
def	get_prefs_block
def	load_block_tree
def	__str__
def	is_platform
def	get_new_flow_graph
def	get_default_flow_graph
def	get_generator
def	get_block_keys
def	get_block
def	get_blocks
def	get_new_block
def	get_name
def	get_key
Static Public Attributes
	FlowGraph = _FlowGraph
	Connection = _Connection
	Block = _Block
	Source = _Port
	Sink = _Port
	Param = _Param
Private Member Functions
def	_load_block
Private Attributes
	_name
	_key
	_block_paths
	_block_dtd
	_block_tree
	_default_flow_graph
	_generator
	_flow_graph
	_blocks
	_blocks_n

---

Detailed Description

Definition at line 34 of file Platform.py.

---

Member Function Documentation

def grc.elements.Platform.Platform.__init__	(		self,
			name,
			key,
			block_paths,
			block_dtd,
			block_tree,
			default_flow_graph,
			generator
	)

Make a platform from the arguments.

Parameters:

	name	the platform name
	key	the unique platform key
	block_paths	the file paths to blocks in this platform
	block_dtd	the dtd validator for xml block wrappers
	block_tree	the nested tree of block keys and categories
	default_flow_graph	the default flow graph file path
	load_one	a single file to load into this platform or None

Returns:

a platform object

Definition at line 36 of file Platform.py.

def grc.elements.Platform.Platform.get_prefs_block

(

self

)

Definition at line 68 of file Platform.py.

def grc.elements.Platform.Platform._load_block	(		self,
			f
	)			[private]

Load the block wrapper from the file path. The block wrapper must pass validation, and have a unique block key. If any of the checks fail, exit with error.

Parameters:

f

the file path

Definition at line 70 of file Platform.py.

def grc.elements.Platform.Platform.load_block_tree	(		self,
			block_tree
	)

Load a block tree with categories and blocks. Step 1: Load all blocks from the xml specification. Step 2: Load blocks with builtin category specifications.

Parameters:

block_tree

the block tree object

Definition at line 89 of file Platform.py.

def grc.elements.Platform.Platform.__str__

(

self

)

Definition at line 117 of file Platform.py.

def grc.elements.Platform.Platform.is_platform

(

self

)

Definition at line 119 of file Platform.py.

def grc.elements.Platform.Platform.get_new_flow_graph

(

self

)

Definition at line 121 of file Platform.py.

def grc.elements.Platform.Platform.get_default_flow_graph

(

self

)

Definition at line 123 of file Platform.py.

def grc.elements.Platform.Platform.get_generator

(

self

)

Definition at line 125 of file Platform.py.

def grc.elements.Platform.Platform.get_block_keys

(

self

)

Definition at line 130 of file Platform.py.

def grc.elements.Platform.Platform.get_block	(		self,
			key
	)

Definition at line 131 of file Platform.py.

def grc.elements.Platform.Platform.get_blocks

(

self

)

Definition at line 132 of file Platform.py.

def grc.elements.Platform.Platform.get_new_block	(		self,
			flow_graph,
			key
	)

Definition at line 133 of file Platform.py.

def grc.elements.Platform.Platform.get_name

(

self

)

Definition at line 135 of file Platform.py.

def grc.elements.Platform.Platform.get_key

(

self

)

Definition at line 137 of file Platform.py.

---

Member Data Documentation

grc.elements.Platform.Platform.FlowGraph = _FlowGraph [static]

Definition at line 142 of file Platform.py.

grc.elements.Platform.Platform.Connection = _Connection [static]

Definition at line 143 of file Platform.py.

grc.elements.Platform.Platform.Block = _Block [static]

Definition at line 144 of file Platform.py.

grc.elements.Platform.Platform.Source = _Port [static]

Definition at line 145 of file Platform.py.

grc.elements.Platform.Platform.Sink = _Port [static]

Definition at line 146 of file Platform.py.

grc.elements.Platform.Platform.Param = _Param [static]

Definition at line 147 of file Platform.py.

grc.elements.Platform.Platform._name [private]

Definition at line 49 of file Platform.py.

grc.elements.Platform.Platform._key [private]

Definition at line 50 of file Platform.py.

grc.elements.Platform.Platform._block_paths [private]

Definition at line 51 of file Platform.py.

grc.elements.Platform.Platform._block_dtd [private]

Definition at line 52 of file Platform.py.

grc.elements.Platform.Platform._block_tree [private]

Definition at line 53 of file Platform.py.

grc.elements.Platform.Platform._default_flow_graph [private]

Definition at line 54 of file Platform.py.

grc.elements.Platform.Platform._generator [private]

Definition at line 55 of file Platform.py.

grc.elements.Platform.Platform._flow_graph [private]

Definition at line 57 of file Platform.py.

grc.elements.Platform.Platform._blocks [private]

Definition at line 59 of file Platform.py.

grc.elements.Platform.Platform._blocks_n [private]

Definition at line 60 of file Platform.py.

---

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

• src/grc/elements/Platform.py (r9379/r9025)

---