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 Defining Class
params list of param-objects plist
readonly flag to indicate that the plist is locked (or not) plist
keys -- No description found -- plist
defaultKeys -- No description found -- plist
name name of the object ltpda_uo
description description of the object 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 Defining Class
plist Plist class object constructor. plist
Back to Top of Section Back to Top of Section

Helper

Methods Description Defining Class
get Get a property of a object. ltpda_obj
setDescription Sets the 'description' property of a ltpda_uo object. ltpda_uo
setName Sets the property 'name' of an ltpda_uoh object. ltpda_uo
addAlternativeKeys Adds some alternative key names to an existing key. plist
append Append a param-object, plist-object or a key/value pair to the parameter list. plist
combine Multiple parameter lists (plist objects) into a single plist. plist
find Overloads find routine for a parameter list. plist
getAllKeys Return all keys (even the alternative key names) of the parameter list. plist
getIndexForKey Returns the index of a parameter with the given key. plist
getKeys Return all the default keys of the parameter list. plist
getOptionsForParam Returns the options for the specified parameter key. plist
getParamValueForParam Returns the paramValue for the specified parameter key. plist
getSelectionForParam Returns the selection mode for the specified parameter key. plist
isparam Look for a given key in the parameter lists. plist
merge The values for the same key of multiple parameter lists together. plist
mfind Multiple-arguments find routine for a parameter list. plist
nparams Returns the number of param objects in the list. plist
propertiesForParam Returns the properties structure for a given parameter. plist
propertyForParam Returns the value of the specified property for a given parameter. plist
pset Set or add a key/value pairor a param-object into the parameter list. plist
regexp Performs a regular expression search on the input plists. plist
remove Remove a parameter from the parameter list. plist
removeKeys Removes keys from a PLIST. plist
search Returns a subset of a parameter list. plist
setDefaultForParam Sets the default value of the param object in dependencies of the 'key' plist
setDescriptionForParam Sets the property 'desc' of the param object in dependencies of the 'key' plist
setOptionsForParam Sets the options of the param object in dependencies of the 'key' plist
setSelectionForParam Sets the selection mode of the param object in dependencies of the 'key' plist
string Converts a plist object to a command string which will recreate the plist object. plist
subset Returns a subset of a parameter list. plist
type Converts the input plist to MATLAB functions. plist
Back to Top of Section Back to Top of Section

Internal

Methods Description Defining Class
isprop Tests if the given field is one of the object properties. ltpda_obj
bsubmit Submits the given collection of objects in binary form to an LTPDA repository ltpda_uo
submit Submits the given collection of objects to an LTPDA repository ltpda_uo
update Updates the given object in an LTPDA repository ltpda_uo
getDescriptionForParam Returns the description for the specified parameter key. plist
getSetRandState Gets or sets the random state of the MATLAB functions 'rand' and 'randn' plist
matchKey Returns a logical array with the same size of the parametes with a 1 if the input key matches to the key name(s) and a 0 if not. plist
matchKeyWithRegexp Returns a logical array with the same size of the parametes with a 1 if the input string matches to the key name(s) and a 0 if not. plist
matchKeys Returns a logical array with the same size of the parametes with a 1 if one of the input key(s) matches to the key name(s) and a 0 if not. plist
parse A plist for strings which can be converted into numbers plist
shouldIgnore True for plists which have the key 'ignore' with the value true. plist
simplify Simplifies a plist. plist
Back to Top of Section Back to Top of Section

Output

Methods Description Defining Class
save Overloads save operator for ltpda objects. ltpda_uo
char Convert a parameter list into a string. plist
display Display plist object. plist
Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defining Class
isequal Overloads the isequal operator for ltpda objects. ltpda_obj
Back to Top of Section Back to Top of Section



©LTP Team