IBM.Watson.DeveloperCloud.Widgets.Widget Class Reference

This is the base class for all widgets. A Widget has any number of inputs and outputs that carry a specific type of data. More...

Inheritance diagram for IBM.Watson.DeveloperCloud.Widgets.Widget:

Classes
class	Data
	This is the base class for any type of data that can be passed through a connection. More...
class	Input
	This object handles input on a widget. More...
class	Output
	This object handles output on a widget. More...

Public Member Functions
delegate void	OnReceiveData (Data data)
	The callback object used by Widget for receiving data from an input. More...
delegate void	OnInputAdded (Input input)
	The callback on input connection added. More...
delegate void	OnInputRemoved (Input input)
	The callback on input connection removed. More...
delegate void	OnOutputAdded (Output output)
	The callback on output connection added. More...
delegate void	OnOutputRemoved (Output output)
	The callback on output connection removed. More...
void	ResolveConnections ()
	Call this function to go ahead and resolve auto-connections to other widgets. Normally, we would try to auto connect when the Awake() is called, this can be called to resolve the auto connections ahead of time. More...

Protected Member Functions
virtual void	Start ()
	<exclude> More...
virtual void	Awake ()
	<exclude> More...
abstract string	GetName ()
	Implemented to provide a friendly name for a widget object. More...

Properties
string	WidgetName [get]
	Returns the name of this widget. More...
Input[]	Inputs [get]
	This returns an array of all inputs on this widget. More...
Output[]	Outputs [get]
	This returns an array of all outputs on this widget. More...

Detailed Description

This is the base class for all widgets. A Widget has any number of inputs and outputs that carry a specific type of data.

Member Function Documentation

virtual void IBM.Watson.DeveloperCloud.Widgets.Widget.Awake ( )

inlineprotectedvirtual

<exclude>

abstract string IBM.Watson.DeveloperCloud.Widgets.Widget.GetName ( )

protectedpure virtual

Implemented to provide a friendly name for a widget object.

Returns

A string containing the name for this widget.

delegate void IBM.Watson.DeveloperCloud.Widgets.Widget.OnInputAdded

(

Input

input

)

The callback on input connection added.

delegate void IBM.Watson.DeveloperCloud.Widgets.Widget.OnInputRemoved

(

Input

input

)

The callback on input connection removed.

delegate void IBM.Watson.DeveloperCloud.Widgets.Widget.OnOutputAdded

(

Output

output

)

The callback on output connection added.

delegate void IBM.Watson.DeveloperCloud.Widgets.Widget.OnOutputRemoved

(

Output

output

)

The callback on output connection removed.

delegate void IBM.Watson.DeveloperCloud.Widgets.Widget.OnReceiveData

(

Data

data

)

The callback object used by Widget for receiving data from an input.

Parameters

data

void IBM.Watson.DeveloperCloud.Widgets.Widget.ResolveConnections ( )

inline

Call this function to go ahead and resolve auto-connections to other widgets. Normally, we would try to auto connect when the Awake() is called, this can be called to resolve the auto connections ahead of time.

virtual void IBM.Watson.DeveloperCloud.Widgets.Widget.Start ( )

inlineprotectedvirtual

<exclude>

Property Documentation

Input [] IBM.Watson.DeveloperCloud.Widgets.Widget.Inputs

get

This returns an array of all inputs on this widget.

Output [] IBM.Watson.DeveloperCloud.Widgets.Widget.Outputs

get

This returns an array of all outputs on this widget.

string IBM.Watson.DeveloperCloud.Widgets.Widget.WidgetName

get

Returns the name of this widget.

---

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

• Scripts/Widgets/Widget.cs