Configurator
Public Member Functions | List of all members
data_structures.Register Class Reference

A module Register. More...

Inheritance diagram for data_structures.Register:
data_structures.Node

Public Member Functions

def __init__
 
def __format__
 
def cpp_header_write
 
def cpp_local_source_write
 
def cpp_remote_source_write
 
def cpp_slave_write
 
def python_write
 
- Public Member Functions inherited from data_structures.Node
def __init__
 Node Constructor
 
def parent_index_find
 Recursively find parent of self starting from root_node.
 
def show
 Method print self indented by indent.
 
def sub_node_append
 Append sub_node to the children sub nodes of self.
 
def xml_write
 Method writes self to out_stream indented by indent.
 

Detailed Description

A module Register.

A register represents a single register that is accessible via remote procedure call. It corresponds as the following XML:

   <Register Name="..." Type="..." Number="..." Brief="...">
   <Description>
     *Description goes here*
   </Description>
   </Register> 

Member Data Documentation

data_structures.Register.attributes register_element.attrib
static
Register: Initialize self from *register_element*. 
data_structures.Register.brief self.brief
static
Register: Write C++ code for *self* to *stream* where
the code is a case clause of a switch statement that
processes a remote procedure call. 
Register: Write the python method functions for *self* to
*out_stream*.  This is both a "get" and a "set" method
function. 
data_structures.Register.name self.name
static
Register: Write out the register method declarations for
*self* to *out_stream*. 
data_structures.Register.style self.style
static
Register: Return a formatted version of *self* controlled by
*fmt*.
If *fmt* is a 'r', a routine name is returned.
If *fmt* is a 'g', a "get" routine name is returned.
if *fmt* is a 's', a "set" routine name is returned.
If *fmt* is a 't', the register type is returned.
If *fmt* is a 'n', the reigster name is returned.  
Register: This routine will write out the implemenation code
template for *self* to *out_stream* using *module* for
fenced code.  

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