Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

WorldViews Class Reference

Set of Retinal_Objects representing the views seen by a set of eyes. More...

#include <worldviews.h>

Inheritance diagram for WorldViews

Inheritance graph

[legend]
Collaboration diagram for WorldViews:

Collaboration graph

[legend]
List of all members.

Interface iterating over eyes; should be used only for output

typedef Retinal_Compositevalue_type
 Type to hold view of world. More...

typedef std::vector<value_typevector_type
 Type of container of world views. More...

typedef vector_type::iterator iterator
 Iterator over the container of world views. More...

typedef vector_type::const_iterator const_iterator
 Iterator over the container of world views. More...

iterator begin ()
 Underlying container's begin(). More...

iterator end ()
 Underlying container's end(). More...

const_iterator begin () const
 Underlying container's begin(). More...

const_iterator end () const
 Underlying container's end(). More...


Public Methods

virtual ~WorldViews ()
virtual void uninit ()
 Reset to initial, undefined state. More...

virtual void init ()
 Initialize input objects and parameters at start of session (after all architecture parameters have been defined); must be called before calling create_object. More...

virtual void reset ()
 Reset each object and the stream of random numbers to their initial values. More...

virtual void reset (long int seed)
 Reset each object to their initial values, and set the stream of random numbers to the given seed value. More...

virtual bool next ()
 Advance to the next state (whatever that means for this object). More...

const Retinal_Objview (int eye) const
 This interface should be avoided if at all possible, since it exposes that a WorldView is a Retinal_Object. More...

This interface probably needs changing; maybe some can be eliminated
void define ( unsigned n_eyes=num_eyes )
 Ensure that the specified number of eyes and their contents exist. More...

bool create_object (StringArgs arglist, const string& name, WorldViews& reference_contents, bool link_eyes=true)
 Create a Retinal_Object and add it to the given set of contents. More...

void remove_object (const string& parent="", const string& name="")
 Remove the given object from the given parent. More...

void print_object ( const string& parent="", const string& name="") const
 Print all objects matching the given parent and name. More...

bool is_empty () const
 Returns true if no object has been defined yet. More...

External interface to a select few quantities needed by other files.
virtual bool is_active (int objnumber, int eye) const
 Whether the given object is currently enabled in the given eye. More...

virtual double angle_of_object (int objnumber, int eye) const
 The angle, in radians, of the given object in the given eye. More...

virtual double angle_of_object_at_location (int i, int j, int eye) const
 Returns the nominal angle of the most active object at the given location in the given eye. More...


Static Public Methods

void set_current_eye (int eye)
 Routines that parse string input for each eye call this function to make input_current_eye available for expressions. More...

void register_params_and_commands ( void )
 This function must be called before any other member function call. More...

cmdstat set_distribution (int dist, bool& changed)
 Obsolete; should only be used by distribution_setfn. More...


Detailed Description

Set of Retinal_Objects representing the views seen by a set of eyes.

Definition at line 64 of file worldviews.h.


Member Typedef Documentation

typedef vector_type::const_iterator WorldViews::const_iterator
 

Iterator over the container of world views.

Definition at line 109 of file worldviews.h.

typedef vector_type::iterator WorldViews::iterator
 

Iterator over the container of world views.

Definition at line 107 of file worldviews.h.

typedef Retinal_Composite* WorldViews::value_type
 

Type to hold view of world.

Definition at line 103 of file worldviews.h.

typedef std::vector<value_type> WorldViews::vector_type
 

Type of container of world views.

Definition at line 105 of file worldviews.h.


Constructor & Destructor Documentation

WorldViews::~WorldViews ( ) [inline, virtual]
 

Definition at line 66 of file worldviews.h.


Member Function Documentation

double WorldViews::angle_of_object ( int objnumber,
int eye ) const [inline, virtual]
 

The angle, in radians, of the given object in the given eye.

Definition at line 136 of file worldviews.h.

Referenced by Eyes::angle_of_object().

double WorldViews::angle_of_object_at_location ( int i,
int j,
int eye ) const [inline, virtual]
 

Returns the nominal angle of the most active object at the given location in the given eye.

Definition at line 146 of file worldviews.h.

Referenced by Eyes::angle_of_object_at_location().

const_iterator WorldViews::begin ( ) const [inline]
 

Underlying container's begin().

Definition at line 115 of file worldviews.h.

iterator WorldViews::begin ( ) [inline]
 

Underlying container's begin().

Definition at line 111 of file worldviews.h.

Referenced by Eyes::activate().

bool WorldViews::create_object ( StringArgs arglist,
const string & name,
WorldViews & reference_contents,
bool link_eyes = true )
 

Create a Retinal_Object and add it to the given set of contents.

Definition at line 561 of file worldviews.c.

void WorldViews::define ( unsigned n_eyes = num_eyes )
 

Ensure that the specified number of eyes and their contents exist.

Definition at line 529 of file worldviews.c.

Referenced by init(), and Eyes::init().

const_iterator WorldViews::end ( ) const [inline]
 

Underlying container's end().

Definition at line 117 of file worldviews.h.

iterator WorldViews::end ( ) [inline]
 

Underlying container's end().

Definition at line 113 of file worldviews.h.

Referenced by Eyes::activate().

void WorldViews::init ( void ) [virtual]
 

Initialize input objects and parameters at start of session (after all architecture parameters have been defined); must be called before calling create_object.

Definition at line 489 of file worldviews.c.

Referenced by Eyes::init().

bool WorldViews::is_active ( int objnumber,
int eye ) const [inline, virtual]
 

Whether the given object is currently enabled in the given eye.

Definition at line 130 of file worldviews.h.

Referenced by Eyes::is_active().

bool WorldViews::is_empty ( ) const [inline]
 

Returns true if no object has been defined yet.

Definition at line 96 of file worldviews.h.

bool WorldViews::next ( void ) [virtual]
 

Advance to the next state (whatever that means for this object).

Reimplemented from ValueGen.

Definition at line 507 of file worldviews.c.

Referenced by Eyes::next().

void WorldViews::print_object ( const string & parent = "",
const string & name = "" ) const
 

Print all objects matching the given parent and name.

Definition at line 653 of file worldviews.c.

void WorldViews::register_params_and_commands ( void ) [static]
 

This function must be called before any other member function call.

Definition at line 52 of file worldviews.c.

void WorldViews::remove_object ( const string & parent = "",
const string & name = "" )
 

Remove the given object from the given parent.

Definition at line 640 of file worldviews.c.

void WorldViews::reset ( long int seed ) [inline, virtual]
 

Reset each object to their initial values, and set the stream of random numbers to the given seed value.

Definition at line 81 of file worldviews.h.

void WorldViews::reset ( ) [inline, virtual]
 

Reset each object and the stream of random numbers to their initial values.

Reimplemented from ValueGen.

Definition at line 77 of file worldviews.h.

Referenced by Eyes::reset().

void WorldViews::set_current_eye ( int eye ) [inline, static]
 

Routines that parse string input for each eye call this function to make input_current_eye available for expressions.

Definition at line 153 of file worldviews.h.

Referenced by create_object(), print_object(), and remove_object().

cmdstat WorldViews::set_distribution ( int dist,
bool & changed ) [static]
 

Obsolete; should only be used by distribution_setfn.

Definition at line 669 of file worldviews.c.

void WorldViews::uninit ( void ) [inline, virtual]
 

Reset to initial, undefined state.

Definition at line 69 of file worldviews.h.

Referenced by Eyes::uninit().

const Retinal_Obj * WorldViews::view ( int eye ) const [inline]
 

This interface should be avoided if at all possible, since it exposes that a WorldView is a Retinal_Object.

Definition at line 122 of file worldviews.h.


The documentation for this class was generated from the following files:
Generated at Mon Aug 21 00:31:29 2000 for RF-LISSOM by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000