plist 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

The LTPDA toolbox restrict access of the properties.

The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).

For example:

val = obj.prop(2).prop;
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
For example:
obj2 = obj1.setName('my name') % This command creates a copy of obj1 (obj1 ~= obj2)
obj.setName('my name');        % This command applies to obj    

Properties Description Defined in class

params

list of param-objects

plist

name

name of the object

ltpda_uo

description

description of the object

ltpda_uo

mdlfile

model xml file of the LTPDAworkbench

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

Constructor Constructor of this class
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Output Output methods
Relational Operator Relational operator methods

Back to Top Back to Top

Constructor

Methods Description Defined in class

plist

PLIST Plist class object constructor.

plist

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

get

GET get a property of a object.

ltpda_obj

append

APPEND append a param-object, plist-object or a key/value pair to the parameter list.

plist

combine

COMBINE multiple parameter lists (plist objects) into a single plist.

plist

find

FIND overloads find routine for a parameter list.

plist

getIndexForKey

GETINDEXFORKEY returns the index of a parameter with the given key.

plist

getKeys

GETKEYS Return all the keys of the parameter list.

plist

getOptionsForParam

GETOPTIONSFORPARAM Returns the options for the specified parameter key.

plist

getParamValueForParam

GETPARAMVALUEFORPARAM Returns the paramValue for the specified parameter key.

plist

getSelectionForParam

GETSELECTIONFORPARAM Returns the selection mode for the specified parameter key.

plist

isparam

ISPARAM look for a given key in the parameter lists.

plist

merge

MERGE the values for the same key of multiple parameter lists together.

plist

mfind

MFIND multiple-arguments find routine for a parameter list.

plist

nparams

NPARAMS returns the number of param objects in the list.

plist

pset

PSET set or add a key/value pairor a param-object into the parameter list.

plist

remove

REMOVE remove a parameter from the parameter list.

plist

removeKeys

REMOVEKEYS removes keys from a PLIST.

plist

setDefaultForParam

SETDEFAULTFORPARAM Sets the default value of the param object in dependencies of the 'key'

plist

setDescription

SETDESCRIPTION sets the 'description' property of a plist object.

plist

setDescriptionForParam

SETDESCRIPTIONFORPARAM Sets the property 'desc' of the param object in dependencies of the 'key'

plist

setMdlfile

SETMDLFILE sets the 'mdlfile' property of a ltpda_uo object.

plist

setName

SETNAME Sets the property 'name' of a plist object.

plist

setOptionsForParam

SETOPTIONSFORPARAM Sets the options of the param object in dependencies of the 'key'

plist

setSelectionForParam

SETSELECTIONFORPARAM Sets the selection mode of the param object in dependencies of the 'key'

plist

string

STRING converts a plist object to a command string which will recreate the plist object.

plist

subset

SUBSET returns a subset of a parameter list.

plist

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

isprop

ISPROP tests if the given field is one of the object properties.

ltpda_obj

bsubmit

BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository

ltpda_uo

submit

SUBMIT Submits the given objects to an LTPDA repository

ltpda_uo

update

UPDATE Updates the given object in an LTPDA repository

ltpda_uo

getDescriptionForParam

GETDESCRIPTIONFORPARAM Returns the description for the specified parameter key.

plist

getSetRandState

GETSETRANDSTATE gets or sets the random state of the MATLAB functions 'rand' and 'randn'

plist

parse

PARSE a plist for strings which can be converted into numbers

plist

plist2cmds

PLIST2CMDS convert a plist to a set of commands.

plist

shouldIgnore

SHOULDIGNORE True for plists which have the key 'ignore' with the value true.

plist

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

char

CHAR convert a parameter list into a string.

plist

display

DISPLAY display plist object.

plist

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

ne

NE overloads the ~= operator for ltpda objects.

ltpda_obj

eq

EQ overloads the == operator for ltpda plist objects.

plist

Back to Top of Section Back to Top of Section




©LTP Team