LTPDA Toolbox™ contents ssm Class   Constructor Examples

timespan 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
startT Start time of the time span. (time-object) timespan
endT End time of the time span. (time-object) timespan
interval Interval between start/end time timespan
timeformat timeformat of the time span (see preferences) timespan
timezone timezone of the time span (see preferences) timespan
hist history of the object (history object) ltpda_uoh
procinfo plist with additional information for an object. ltpda_uoh
plotinfo plotinfo object ltpda_uoh
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
rebuild Rebuilds the input objects using the history. ltpda_uoh
timespan Timespan object class constructor. timespan
Back to Top of Section Back to Top of Section

Helper

Methods Description Defining Class
get Get a property of a object. ltpda_obj
search Select objects that match the given name. ltpda_uo
setDescription Sets the 'description' property of a ltpda_uo 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
setPlotAxes Sets the 'axes' property of a the object's plotinfo. ltpda_uoh
setPlotColor Sets the color of a the object's plotinfo. ltpda_uoh
setPlotFigure Sets the 'figure' property of a the object's plotinfo. ltpda_uoh
setPlotFillmarker Defines if the plot function fill the marker or not. ltpda_uoh
setPlotLineStyle Sets the linestyle of a the object's plotinfo. ltpda_uoh
setPlotLinewidth Sets the linewidth of a the object's plotinfo. ltpda_uoh
setPlotMarker Sets the marker of a the object's plotinfo. ltpda_uoh
setPlotMarkerEdgeColor Sets the color of a the object's marker edge. ltpda_uoh
setPlotMarkerFaceColor Sets the color of a the object's marker face. ltpda_uoh
setPlotMarkersize Sets the markersize of a the object's plotinfo. ltpda_uoh
setPlotinfo Sets the 'plotinfo' property of a ltpda_uoh object. ltpda_uoh
setPlottingStyle Sets the style property of a the object's plotinfo. ltpda_uoh
setProcinfo Sets the 'procinfo' property of a ltpda_uoh object. ltpda_uoh
setShowsErrors Sets the 'showErrors' property of a the object's plotinfo. ltpda_uoh
getEndT Get the timespan property 'endT'. timespan
getNsecs Get the timespan property 'nsecs'. timespan
getStartT Get the timespan property 'startT'. timespan
human Returns a human readable string representing the time range. timespan
inTimespan Checks if an input time is inbetween a timespan. timespan
merge The input timespan objects into one output timespan object. timespan
minus Implements subtraction operator for timespan objects. timespan
plus Implements addition operator for timespan objects. timespan
setEndT Sets the 'endT' property of the timespan objects. timespan
setStartT Sets the 'startT' property of the timespan objects. timespan
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
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
double Overloads double() function for timespan objects. timespan
generateConstructorPlist Generates a PLIST from the properties which can rebuild the object. timespan
plot The timespan objects on the given axes. timespan
Back to Top of Section Back to Top of Section

Output

Methods Description Defining Class
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
char Convert a timespan object into a string. timespan
display Overloads display functionality for timespan objects. timespan
table Display the an array of timespan objects in a table. timespan
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


ssm Class  ssm Class   Constructor Examples Constructor Examples

©LTP Team