#include <SharedFinfo.h>

Inheritance diagram for SharedFinfo:

Collaboration diagram for SharedFinfo:

Public Member Functions
bool	addMsg (const Finfo target, ObjId mid, Element src) const

bool	checkTarget (const Finfo *target) const

const vector< Finfo * > &	dest () const

vector< string >	innerDest () const

vector< string >	innerSrc () const

void	registerFinfo (Cinfo *c)

string	rttiType () const
	This always returns void. We need to check the subsidiary Finfos. More...

	SharedFinfo (const string &name, const string &doc, Finfo **entries, unsigned int numEntries)

const vector< SrcFinfo * > &	src () const

bool	strGet (const Eref &tgt, const string &field, string &returnValue) const

bool	strSet (const Eref &tgt, const string &field, const string &arg) const

	~SharedFinfo ()

Public Member Functions inherited from Finfo
const string &	docs () const
	Returns documentation string. More...

	Finfo (const string &name, const string &doc)

const string &	name () const

virtual void	postCreationFunc (Id newId, Element *newElm) const

virtual	~Finfo ()

Private Attributes
vector< Finfo * >	dest_

vector< SrcFinfo * >	src_

Additional Inherited Members
Static Public Member Functions inherited from Finfo
static const Cinfo *	initCinfo ()

Detailed Description

This is a SharedFinfo, which wraps an arbitrary set of regular Src and Dest Messages. Its main job is to do typechecking for setting up multiple data streams to go across the same Msg.

Definition at line 18 of file SharedFinfo.h.

Constructor & Destructor Documentation

SharedFinfo::SharedFinfo	(	const string &	name,
		const string &	doc,
		Finfo **	entries,
		unsigned int	numEntries
	)

This set of classes define Message Sources. Their main job is to supply a type-safe send operation, and to provide typechecking for it.

Definition at line 16 of file SharedFinfo.cpp.

References dest_, numEntries, and src_.

     : Finfo( name, doc )
 {
     for ( unsigned int i = 0; i < numEntries; ++i )
     {
         Finfo* foo = entries[i];
         SrcFinfo* s = dynamic_cast< SrcFinfo* >( foo );
         // SrcFinfo* s = dynamic_cast< SrcFinfo* >( entries[i] );
         if ( s != 0 )
             src_.push_back( s );
         else
             dest_.push_back( entries[i] );
     }
 }

SharedFinfo::~SharedFinfo ( )

inline

Definition at line 24 of file SharedFinfo.h.

24 {;}

Member Function Documentation

bool SharedFinfo::addMsg	(	const Finfo *	target,
		ObjId	mid,
		Element *	src
	)		const

virtual

First calls checkTarget on all targets, then sets up message. Returns true on success.

Reimplemented from Finfo.

Definition at line 95 of file SharedFinfo.cpp.

References checkTarget(), dest_, Msg::e1(), Msg::e2(), Msg::getMsg(), Element::getName(), Element::id(), and src_.

 {
     if ( !checkTarget( target ) )
         return 0;
     const SharedFinfo* tgt = dynamic_cast< const SharedFinfo* >( target );
 
     // We have a problem if the src and dest elms (e1 and e2) are the
     // same, because this messes up the logic to assign the isForward flag.
     // This is an issue only if the target Finfo wants to send data back.
     // In other words, there are dest_ finfos on this SharedFinfo.
     // Report this problem.
     const Msg* m = Msg::getMsg( mid );
     assert( m->e1() == srcElm );
     Element* destElm = m->e2();
     if ( srcElm == destElm && srcElm->id() != Id() ) {
         if ( dest_.size() > 0 ) {
             cout << "Error: SharedFinfo::addMsg: MessageId " << mid <<
             endl <<
             "Source Element == DestElement == " << srcElm->getName() <<
             endl << "Recommend that you individually set up messages for" <<
             " the components of the SharedFinfo, to ensure that the " <<
             "direction of messaging is consistent.\n";
             return 0;
         }
     }
 
 
     for ( unsigned int i = 0; i < src_.size(); ++i ) {
         if ( !src_[i]->addMsg( tgt->dest_[i], mid, srcElm ) ) {
             // Should never happen. The checkTarget should preclude this.
             cerr << "Error:SharedFinfo::addMsg: Failed on MessageId " <<
                 mid << ", unrecoverable\n";
             exit(0);
         }
     }
 
 
     for ( unsigned int i = 0; i < tgt->src_.size(); ++i ) {
         if ( !tgt->src_[i]->addMsg( dest_[i], mid, destElm ) ) {
             // Should never happen. The checkTarget should preclude this.
             cerr << "Error:SharedFinfo::addMsg: Failed on MessageId " <<
                 mid << ", unrecoverable\n";
             exit( 0 );
         }
     }
     return 1;
 }

Here is the call graph for this function:

bool SharedFinfo::checkTarget ( const Finfo * target ) const

virtual

Checks that the type of target Finfo matches self, and is safe to exchange messages with.

It is possible that we have DestFinfos in this SharedFinfo, that have not been registered. So we need to scan through. Note that the register operation overwrites values if they already exist. Best not to have conflicts!.

Reimplemented from Finfo.

Definition at line 74 of file SharedFinfo.cpp.

References dest_, and src_.

Referenced by addMsg().

 {
     const SharedFinfo* tgt = dynamic_cast< const SharedFinfo* >( target );
     if ( tgt ) {
         if ( src_.size() != tgt->dest_.size() &&
             dest_.size() != tgt->src_.size() )
             return 0;
         for ( unsigned int i = 0; i < src_.size(); ++i ) {
             if ( !src_[i]->checkTarget( tgt->dest_[i] ) )
                 return 0;
         }
         for ( unsigned int i = 0; i < tgt->src_.size(); ++i ) {
             if ( !tgt->src_[i]->checkTarget( dest_[i] ) )
                 return 0;
         }
 
         return 1;
     }
     return 0;
 }

Here is the caller graph for this function:

const vector< Finfo * > & SharedFinfo::dest ( ) const

Definition at line 150 of file SharedFinfo.cpp.

References dest_.

Referenced by Element::getNeighbors(), and insertSharedMsgs().

 {
     return dest_;
 }

Here is the caller graph for this function:

vector< string > SharedFinfo::innerDest ( ) const

virtual

Returns subsidiary DestFinfos

Reimplemented from Finfo.

Definition at line 167 of file SharedFinfo.cpp.

References dest_.

 {
     vector< string > ret;
     for ( vector< Finfo* >::const_iterator i = dest_.begin();
         i != dest_.end(); ++i )
         ret.push_back( (*i)->name() );
     return ret;
 }

vector< string > SharedFinfo::innerSrc ( ) const

virtual

Returns subsidiary SrcFinfos

Reimplemented from Finfo.

Definition at line 158 of file SharedFinfo.cpp.

References src_.

 {
     vector< string > ret;
     for ( vector< SrcFinfo* >::const_iterator i = src_.begin();
         i != src_.end(); ++i )
         ret.push_back( (*i)->name() );
     return ret;
 }

void SharedFinfo::registerFinfo ( Cinfo * c )

virtual

Returns string-ified form to handle template expectations for name field string getName() const; Assign function Ids, bindIndex and so on.

Implements Finfo.

Definition at line 32 of file SharedFinfo.cpp.

References dest_, Cinfo::registerFinfo(), and src_.

 {
     for( vector< SrcFinfo* >::iterator i =
         src_.begin(); i != src_.end(); ++i)
         c->registerFinfo( *i );
     for( vector< Finfo* >::iterator i =
         dest_.begin(); i != dest_.end(); ++i)
         c->registerFinfo( *i );
 }

Here is the call graph for this function:

string SharedFinfo::rttiType ( ) const

virtual

This always returns void. We need to check the subsidiary Finfos.

Reimplemented from Finfo.

Definition at line 176 of file SharedFinfo.cpp.

 {
     return "void";
 }

const vector< SrcFinfo * > & SharedFinfo::src ( ) const

Definition at line 144 of file SharedFinfo.cpp.

References src_.

Referenced by Element::getNeighbors().

 {
     return src_;
 }

Here is the caller graph for this function:

bool SharedFinfo::strGet	(	const Eref &	tgt,
		const string &	field,
		string &	returnValue
	)		const

virtual

Function to return value of field into a string argument. Returns true on success. Normally called only from SetGet::strGet.

Implements Finfo.

Definition at line 48 of file SharedFinfo.cpp.

 {
     return 0;
 }

bool SharedFinfo::strSet	(	const Eref &	tgt,
		const string &	field,
		const string &	arg
	)		const

virtual

Function to set this field using a string argument. Returns true on success. Normally called only from SetGet::strSet.

Implements Finfo.

Definition at line 42 of file SharedFinfo.cpp.

 {
     return 0;
 }

Member Data Documentation

vector< Finfo* > SharedFinfo::dest_

private

Definition at line 60 of file SharedFinfo.h.

Referenced by addMsg(), checkTarget(), dest(), innerDest(), registerFinfo(), and SharedFinfo().

vector< SrcFinfo* > SharedFinfo::src_

private

Definition at line 59 of file SharedFinfo.h.

Referenced by addMsg(), checkTarget(), innerSrc(), registerFinfo(), SharedFinfo(), and src().

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

moose-core/basecode/SharedFinfo.h
moose-core/basecode/SharedFinfo.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation