Documentation Center

  • Trial Software
  • Product Updates

simscape.logging.Node class

Package: simscape.logging

Represent hierarchy tree for simulation data

Description

This class represents the hierarchy of nodes for logging simulation data in a model. The tree starts with the workspace variable, which represents simulation data for the whole model, and recursively creates nodes for each of the children. The children are defined depending on the type of the parent node:

  • For the top-level simulation log workspace variable, the children are all the Simscape™ blocks (and subsystems containing Simscape blocks) in the top-level model diagram.

  • For a subsystem or a structural block, the children are all the constituent Simscape blocks and subsystems.

  • For a block, the children are all its physical ports, Through and Across variables, and all internal variables defined in the block's Simscape file.

  • For a physical port, the children are all its Across variables.

Final nodes in this recursion correspond to all the variables logged for the model. Final nodes do not have children nodes, and contain the series data logged during simulation.

You cannot construct an object of this class. The object is constructed automatically during simulation, as part of the simulation log workspace variable, if you enable data logging for the model.

Properties

id

The string identifying the Node object. For the simulation log workspace variable, this is the name of the top-level block diagram. For blocks and subsystems, the id is constructed automatically as a valid MATLAB® identifier based on the name of the block or subsystem. For other types, the id is the name of the corresponding port or variable.

series

For Node objects that do not have children nodes, and therefore correspond to the logged variables, the series property returns an object of the simscape.logging.Series class that contains the simulation series data for this variable. For nodes that do not represent variables, the series property is hidden. If you access the hidden series property for such node, the property returns an object of the simscape.logging.Series class representing an empty series (with zero points).

The other properties are dynamic, and represent all the children of the Node object.

Methods

plotPlot all series associated with node object
plotxyPlot series associated with two node objects against each other
printPrint complete logging tree of node object

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects in the MATLAB Programming Fundamentals documentation.

See Also

Tutorials

How To

Was this topic helpful?