Class Files

Class files have the file extension .ikc and describes the interface to a particular module class in ikaros.

The class file lists inputs, outputs and parameters to a module class.

<class name="myclass">
   <parameter name="x" type="number" />
   <input name="INPUT" />
   <output name="OUTPUT" size="10" />
</class>

The type of a parameter can be either of number, string, bool or matrix.

The possible values of a parameter can be constrained by the options attribute. For exanample, the follwing will imit the values to three possibilities. If it is a number, the values will be 0,1 or 2. If its is a string, the three strings in the options will be used:

 <parameter name="x" type="number" options="A,B,C" />

In addition, all elements should also include a description attribute that describes the function of it.