A class for logging the internal data over time during a ODE simulation process. More...

Inheritance diagram for SimLogger:
[legend]

Public Member Functions

 SimLogger (DynamicalSystem plant)
 Constructor function. More...
 
function obj = initialize ()
 Initializes the logger. More...
 
function status = updateLog ()
 push the current recorded data into the stack More...
 
function status = updateLastLog ()
 updates the last set of recorded data More...
 

Public Attributes

struct calc
 recorded data at one time instant More...
 
struct static
 The static data that are time-independent. More...
 
struct flow
 The time-dependent data along the simulated trajectory. More...
 
DynamicalSystem plant
 The dynamical system model associated with the logger. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Protected Attributes

cell calcs
 a stack of recorded data during a certain time duration More...
 

Detailed Description

A class for logging the internal data over time during a ODE simulation process.

Author
Ayonga Hereid
Date
2016-09-26

Copyright (c) 2016, AMBER Lab All right reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted only in compliance with the BSD 3-Clause license, see http://www.opensource.org/licenses/bsd-license.php

Constructor & Destructor Documentation

◆ SimLogger()

SimLogger.SimLogger ( DynamicalSystem  plant)
inline

Constructor function.

Parameters
plantthe dynamical system model

Member Function Documentation

◆ initialize()

function obj = SimLogger.initialize ( )
inline

Initializes the logger.

◆ updateLastLog()

function status = SimLogger.updateLastLog ( )
inline

updates the last set of recorded data

◆ updateLog()

function status = SimLogger.updateLog ( )
inline

push the current recorded data into the stack

Member Data Documentation

◆ calc

SimLogger.calc

recorded data at one time instant

◆ calcs

SimLogger.calcs
protected

a stack of recorded data during a certain time duration

◆ flow

SimLogger.flow

The time-dependent data along the simulated trajectory.

Note
This property has the MATLAB attribute Dependent set to true.
Matlab documentation of property attributes.
[readonly]

◆ plant

SimLogger.plant

The dynamical system model associated with the logger.

Note
This property has non-standard access specifiers: SetAccess = Protected, GetAccess = Public
Matlab documentation of property attributes.

◆ static

SimLogger.static

The static data that are time-independent.


The documentation for this class was generated from the following file:
  • /home/ayonga/.dropboxes/business/Dropbox/research/dzopt/frost/matlab/SimLogger.m