mtkParameter-class: The 'mtkParameter' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkParameter class is a class used to manage the parameter concept.

Class Hierarchy

Parent classes :

mtkValue

Direct Known Subclasses :

Constructor

mtkParameter

signature(name='unknown', type='logical', val=NULL)

make.mtkParameterList

signature(x=list())

Slots

name:

(character) the name of the parameter.

type:

(character) the type of the parameter.

val:

(ANY) the value of the parameter.

Methods

getName

signature( this = "mtkParameter"): Returns the value of the slot "name".

getValue

signature( this = "mtkParameter"): Returns the value of the slot "val".

getType

signature(this = "mtkParameter"): Returns the value of the slot "type".

setName

signature( this = "mtkParameter", name="character"): Gives a new value to the slot "name".

setValue

signature( this = "mtkParameter", val="ANY"): Gives a new value to the slot "val".

setType

signature(this = "mtkParameter", type="character"): Gives a new value to the slot "type".

show

signature( object = "mtkParameter"): Prints a report of the data managed by the underlying object.

print

signature(x = "mtkParameter"): Prints the information managed by the underlying object.

Author(s)

Juhui WANG, MIA-jouy, INRA

Examples

# Create an object of the 'mtkParameter' class.

	p <- mtkParameter(name="x", type="double", val=0.0)

# We usually use the 'make.mtkParameterList()' function to define a list of
# 'mtkParameter' instead of the constructor 
# of the 'mtkParameter' class
	plist <- make.mtkParameterList(list(min=-1,max=+1,shape="hello"))

mtk documentation built on May 2, 2019, 4:15 a.m.