Package mbdyn :: Module groups :: Class ReferenceList
[hide private]

Class ReferenceList

source code

               object --+        
                        |        
                     list --+    
                            |    
record.RecordBase --+       |    
                    |       |    
        record.Record --+   |    
                        |   |    
       common.BasicObject --+    
                            |    
                    ItemGroup --+
                                |
                               ReferenceList
Known Subclasses:
interface.groups.ReferenceList

A group (or list) of reference frames. As the reference frames just have a single class definition, their container is also simpler.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
add(self, reference)
Add a reference frame to the list of reference, see add_item of ItemGroup.
source code
 
write_into(self, file_to_write)
Write the reference block into the MBDyn input file
source code
 
collect_parameters(self)
Collect the parameters of own_para_names that need to be saved (or pickled) in the result file
source code
 
set_parameters(self, para)
Use the values from para to retrieved the reference frames when the simulation is loaded from a file.
source code

Inherited from ItemGroup: add_item, get, get_from_label, get_number, set_labels, set_labels_auto, set_names_auto

Inherited from ItemGroup (private): _is_more_than_one_time

Inherited from list: __add__, __contains__, __delitem__, __delslice__, __eq__, __ge__, __getattribute__, __getitem__, __getslice__, __gt__, __hash__, __iadd__, __imul__, __iter__, __le__, __len__, __lt__, __mul__, __ne__, __new__, __repr__, __reversed__, __rmul__, __setitem__, __setslice__, append, count, extend, index, insert, pop, remove, reverse, sort

Inherited from object: __delattr__, __reduce__, __reduce_ex__, __setattr__, __str__

Inherited from common.BasicObject: get_lines, get_mbdyn_instance, set_comment, set_label, set_name, set_simulation_ref

Inherited from record.Record: common_init_results, init_results, save, set_own_parameters, will_save, will_save_nothing, will_save_only

Inherited from record.RecordBase: collect_own_parameters, set_own_para

Inherited from record.RecordBase (private): _collect_own_para

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Returns:
new list

Overrides: ItemGroup.__init__

collect_parameters(self)

source code 
Collect the parameters of own_para_names that need to be saved (or pickled) in the result file
Overrides: record.RecordBase.collect_parameters

set_parameters(self, para)

source code 
Use the values from para to retrieved the reference frames when the simulation is loaded from a file.
Overrides: record.RecordBase.set_parameters