C# Class Quelea.AbstractComponent

Inheritance: GH_Component
Show file Open project: lxfschr/Quelea

Protected Properties

Property Type Description
nextInputIndex int

Protected Methods

Method Description
AbstractComponent ( string name, string nickname, string description, string category, string subcategory, Bitmap icon, string componentGuid ) : System

Initializes a new instance of the AbstractRuleComponent class.

GetInputs ( IGH_DataAccess da ) : bool

Gets the data from da and checks that the input data is valid.

RegisterInputParams ( GH_InputParamManager pManager ) : void

Registers all the input parameters for this component.

RegisterOutputParams ( GH_OutputParamManager pManager ) : void

Registers all the output parameters for this component.

SetOutputs ( IGH_DataAccess da ) : void

Solves for and sets the output data based on the inputs.

SolveInstance ( IGH_DataAccess da ) : void

This is the method that actually does the work.

Method Details

AbstractComponent() protected method

Initializes a new instance of the AbstractRuleComponent class.
protected AbstractComponent ( string name, string nickname, string description, string category, string subcategory, Bitmap icon, string componentGuid ) : System
name string
nickname string
description string
category string
subcategory string
icon System.Drawing.Bitmap
componentGuid string
return System

GetInputs() protected abstract method

Gets the data from da and checks that the input data is valid.
protected abstract GetInputs ( IGH_DataAccess da ) : bool
da IGH_DataAccess The object that gives access to inputs and outputs.
return bool

RegisterInputParams() protected abstract method

Registers all the input parameters for this component.
protected abstract RegisterInputParams ( GH_InputParamManager pManager ) : void
pManager GH_InputParamManager
return void

RegisterOutputParams() protected abstract method

Registers all the output parameters for this component.
protected abstract RegisterOutputParams ( GH_OutputParamManager pManager ) : void
pManager GH_OutputParamManager
return void

SetOutputs() protected abstract method

Solves for and sets the output data based on the inputs.
protected abstract SetOutputs ( IGH_DataAccess da ) : void
da IGH_DataAccess The object that gives access to inputs and outputs.
return void

SolveInstance() protected method

This is the method that actually does the work.
protected SolveInstance ( IGH_DataAccess da ) : void
da IGH_DataAccess The DA object is used to retrieve from inputs and store in outputs.
return void

Property Details

nextInputIndex protected property

protected int nextInputIndex
return int