An intermediate class that holds information about what kind of input objects a certain VObject accepts. More...

#include </home/werner/origo/vish/ocean/plankton/VAcceptInfo.hpp>

Public Member Functions

VAcceptInfo (const type_info &type, const RefPtr< InterfaceBase > &=NullPtr())
Create information what kind of input an object might accept.
VAcceptInfo (const type_info &type, const std::string &MatchedOutputSlotName)
~VAcceptInfo ()
Destructor.

Static Public Member Functions

static void accept_info_check (const string &object_name, const type_info &what)
static void accept_info_check_no (const string &object_name, const type_info &what)
static void accept_info_check_yes (const string &object_name, const type_info &what)
static RefPtr< VAcceptInfo > adjustSuitability (const RefPtr< VAcceptInfo > &AI, double value)
Set the suitability value.
static RefPtr< VAcceptInfo > setReason (const RefPtr< VAcceptInfo > &AI, const string &reason)
Specify the reason why this acceptance is a good match.

Public Attributes

vector< string > Category
A naming scheme for the related object.
string FoundOutputSlotName
The name of the output slot found.
RefPtr< MemCore::InterfaceBase > ib
If this type is implemented in an interface rather than the object itself, say so here in this interface.
double suitability
How well this acceptance suits the given object.
const type_info & what
The type which is accepted here.
string why
An optional text information telling why this is a good match.

Friends

RefPtr< VAcceptInfo > operator& (const RefPtr< VAcceptInfo > &AI, const string &reason)
Convenience operator to set the reason information by just adding a string to the pointer.
RefPtr< VAcceptInfo > operator* (const RefPtr< VAcceptInfo > &AI, double value)
Convenience operator to set the suitability flag by just multiplying the pointer with a double value.

Detailed Description

An intermediate class that holds information about what kind of input objects a certain VObject accepts.

A certain VObject may be queried for VObject Creators which accept this certain VObject as input. It will provide a list of VAcceptInfo objects.

Currently, only VObjects can be queried; in principle, this query could be generalized to any VInputBase object, but it is not sure yet how such a query should be initiated.

Member Function Documentation

static RefPtr<VAcceptInfo> Wizt::VAcceptInfo::adjustSuitability	(	const RefPtr< VAcceptInfo > &	AI,
		double	value
	)		`[inline, static]`

Set the suitability value.

It will be multiplied by the given value, initially it is set to 1.0. Adjusting the suitability may thus increase or decrease the matching. Giving a value of zero here will specify that this is a bad match and should not be used. It's just a possible match, but not a good one.

static RefPtr<VAcceptInfo> Wizt::VAcceptInfo::setReason	(	const RefPtr< VAcceptInfo > &	AI,
		const string &	reason
	)		`[inline, static]`

Specify the reason why this acceptance is a good match.

This is supposed to be helpful information to the enduser.

Member Data Documentation

string Wizt::VAcceptInfo::why

An optional text information telling why this is a good match.

This text may contain useful information to the user and should be used in conjunction with the suitability value.

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

ocean/plankton/VAcceptInfo.hpp
ocean/plankton/VAcceptInfo.cpp