param Class


Properties Properties of the class
Methods All Methods of the class ordered by category.
Examples Some constructor examples

Back to Class descriptions Back to Class descriptions

Properties

Public Properties Public means that all clients can access the member by its name.
Private Properties Private restricts the access to the class itself. Only methods that are part of the same class can access private members.

Back to Top Back to Top

Public Properties

Properties Description

name

Name of the parameter object (PARAM)

key

Key of the key/value pair

val

Value of the key/value pair

Private Properties

Properties Description

version

CVS version string of the constructor

created

Time object which stores the creation time of the PARAM object

Methods

Constructor Constructor of this class
Helper Helper functions only for internal usage
Internal Internal functions only for internal usage
Output Output functions

Back to Top Back to Top

Constructor

Methods Description

param

PARAM Parameter object class constructor.

Back to Top of Section Back to Top of Section

Helper

Methods Description

cat

CAT concatenate params into a vector.

get

GET get parameter properties.

isfield

No description

isvalid

ISVALID tests if the given param has all the correct fields of the correct type.

mux

MUX concatenate params into a vector.

set

SET set a parameter property.

Back to Top of Section Back to Top of Section

Internal

Methods Description

subsasgn

SUBSASGN define index assignment for parameter properties.

subsref

SUBSREF Define field name indexing for parameter objects.

Back to Top of Section Back to Top of Section

Output

Methods Description

char

CHAR convert a param object into a string.

display

DISPLAY display a parameter

display2

DISPLAY display a parameter

save

SAVE a param object to file.

string

STRING writes a command string that can be used to recreate the input param object.

Back to Top of Section Back to Top of Section




©LTP Team