grc.elements.Block.Block Class Reference

Inheritance diagram for grc.elements.Block.Block:

Inheritance graph
[legend]

List of all members.

Public Member Functions

def __init__
def test
def get_enabled
def set_enabled
def validate
def __str__
def get_id
def is_block
def get_doc
def get_name
def get_key
def get_category
def get_doc
def get_ports
def get_param_keys
def get_param
def get_params
def get_sink_keys
def get_sink
def get_sinks
def get_source_keys
def get_source
def get_sources
def get_connections
def resolve_dependencies
def export_data
def import_data

Private Attributes

 _name
 _key
 _category
 _params
 _sources
 _sinks


Detailed Description

Definition at line 53 of file Block.py.


Member Function Documentation

def grc.elements.Block.Block.__init__ (   self,
  flow_graph,
  n 
)

Make a new block from nested data.
@param flow graph the parent element
@param n the nested odict
@return block a new block

Definition at line 55 of file Block.py.

def grc.elements.Block.Block.test (   self  ) 

Call test on all children.

Reimplemented from grc.elements.Element.Element.

Definition at line 124 of file Block.py.

def grc.elements.Block.Block.get_enabled (   self  ) 

Get the enabled state of the block.

Returns:
true for enabled

Definition at line 130 of file Block.py.

def grc.elements.Block.Block.set_enabled (   self,
  enabled 
)

Set the enabled state of the block.

Parameters:
enabled true for enabled

Definition at line 138 of file Block.py.

def grc.elements.Block.Block.validate (   self  ) 

Validate the block.
All ports and params must be valid.
All checks must evaluate to true.

Reimplemented from grc.elements.Element.Element.

Definition at line 145 of file Block.py.

def grc.elements.Block.Block.__str__ (   self  ) 

Definition at line 158 of file Block.py.

def grc.elements.Block.Block.get_id (   self  ) 

Definition at line 160 of file Block.py.

def grc.elements.Block.Block.is_block (   self  ) 

Reimplemented from grc.elements.Element.Element.

Definition at line 162 of file Block.py.

def grc.elements.Block.Block.get_doc (   self  ) 

Definition at line 164 of file Block.py.

def grc.elements.Block.Block.get_name (   self  ) 

Definition at line 166 of file Block.py.

def grc.elements.Block.Block.get_key (   self  ) 

Definition at line 168 of file Block.py.

def grc.elements.Block.Block.get_category (   self  ) 

Definition at line 170 of file Block.py.

def grc.elements.Block.Block.get_doc (   self  ) 

Definition at line 172 of file Block.py.

def grc.elements.Block.Block.get_ports (   self  ) 

Definition at line 174 of file Block.py.

def grc.elements.Block.Block.get_param_keys (   self  ) 

Definition at line 179 of file Block.py.

def grc.elements.Block.Block.get_param (   self,
  key 
)

Definition at line 180 of file Block.py.

def grc.elements.Block.Block.get_params (   self  ) 

Definition at line 181 of file Block.py.

def grc.elements.Block.Block.get_sink_keys (   self  ) 

Definition at line 186 of file Block.py.

def grc.elements.Block.Block.get_sink (   self,
  key 
)

Definition at line 187 of file Block.py.

def grc.elements.Block.Block.get_sinks (   self  ) 

Definition at line 188 of file Block.py.

def grc.elements.Block.Block.get_source_keys (   self  ) 

Definition at line 193 of file Block.py.

def grc.elements.Block.Block.get_source (   self,
  key 
)

Definition at line 194 of file Block.py.

def grc.elements.Block.Block.get_sources (   self  ) 

Definition at line 195 of file Block.py.

def grc.elements.Block.Block.get_connections (   self  ) 

Definition at line 197 of file Block.py.

def grc.elements.Block.Block.resolve_dependencies (   self,
  tmpl 
)

Resolve a paramater dependency with cheetah templates.
@param tmpl the string with dependencies
@return the resolved value

Definition at line 200 of file Block.py.

def grc.elements.Block.Block.export_data (   self  ) 

Import/Export Methods

Export this block's params to nested data.
@return a nested data odict

Definition at line 215 of file Block.py.

def grc.elements.Block.Block.import_data (   self,
  n 
)

Import this block's params from nested data.
Any param keys that do not exist will be ignored.
@param n the nested data odict

Definition at line 225 of file Block.py.


Member Data Documentation

grc.elements.Block.Block._name [private]

Definition at line 72 of file Block.py.

grc.elements.Block.Block._key [private]

Definition at line 73 of file Block.py.

grc.elements.Block.Block._category [private]

Definition at line 74 of file Block.py.

grc.elements.Block.Block._params [private]

Definition at line 76 of file Block.py.

grc.elements.Block.Block._sources [private]

Definition at line 104 of file Block.py.

grc.elements.Block.Block._sinks [private]

Definition at line 113 of file Block.py.


The documentation for this class was generated from the following file:
Generated on Sat Aug 23 02:00:11 2008 for GNU Radio Companion by  doxygen 1.5.4