collection 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
objs objects in collection collection
hist history of the object (history object) ltpda_uoh
procinfo plist with additional information for an object. ltpda_uoh
plotinfo plist with the plot information ltpda_uoh
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 Defining Class
collection Constructor for collection class. collection
rebuild Rebuilds the input objects using the history. ltpda_uoh
Back to Top of Section Back to Top of Section

Helper

Methods Description Defining Class
addObjects Adds the given objects to the collection. collection
getObjectAtIndex Index into the inner objects of one collection object. collection
getObjectsOfClass Returns all objects of the specified class in a collection-object. collection
nobjs Returns the number of objects in the inner object array. collection
removeObjectAtIndex Removes the object at the specified position from the collection. collection
setObjectAtIndex Sets an input object to the collection. collection
setObjs Sets the 'objs' property of a collection object. collection
get Get a property of a object. ltpda_obj
setDescription Sets the 'description' property of a ltpda_uoh object. ltpda_uo
setMdlfile Sets the 'mdlfile' property of a ltpda_uoh object. ltpda_uo
setName Sets the property 'name' of an ltpda_uoh object. ltpda_uo
created Returns a time object of the last modification. ltpda_uoh
creator Extract the creator(s) from the history. ltpda_uoh
csvexport Exports the data of an object to a csv file. ltpda_uoh
index Index into a 'ltpda_uoh' object array or matrix. This properly captures the history. ltpda_uoh
requirements Returns a list of LTPDA extension requirements for a given object. ltpda_uoh
setPlotinfo Sets the 'plotinfo' property of a ltpda_uoh object. ltpda_uoh
setProcinfo Sets the 'procinfo' property of a ltpda_uoh object. ltpda_uoh
Back to Top of Section Back to Top of Section

Internal

Methods Description Defining Class
generateConstructorPlist Generates a PLIST from the properties which can rebuild the object. collection
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 objects to an LTPDA repository ltpda_uo
update Updates the given object in an LTPDA repository ltpda_uo
string Writes a command string that can be used to recreate the input object(s). ltpda_uoh
type Converts the input objects to MATLAB functions. ltpda_uoh
Back to Top of Section Back to Top of Section

Output

Methods Description Defining Class
char Convert a collection object into a string. collection
display Overloads display functionality for collection objects. collection
unpack Unpacks the objects in a collection and sets them to the given output collection
save Overloads save operator for ltpda objects. ltpda_uo
report Generates an HTML report about the input objects. ltpda_uoh
viewHistory Displays the history of an object as a dot-view or a MATLAB figure. ltpda_uoh
Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defining Class
eq Overloads the == operator for ltpda objects. ltpda_obj
ne Overloads the ~= operator for ltpda objects. ltpda_obj
Back to Top of Section Back to Top of Section



©LTP Team