NetCDFGroup

A group of NetCDF variables, dimensions, attributes, and child groups.

---

Declaration

classdef NetCDFGroup < handle

Overview

NetCDFGroup represents a single NetCDF group (including the root group) and provides a uniform interface for:

• Creating and registering coordinate dimensions (and their coordinate variables)
• Creating, registering, and reading variables (real and complex)
• Creating and traversing a group hierarchy
• Managing group-level (global) attributes

Typical usage is through NetCDFFile, which constructs the root group and then exposes methods that delegate to this class.

Topics

• Initializing
  • NetCDFGroup Create and manage a NetCDF group.
• Accessing group properties
  • dump Display group contents to the command window.
  • id of the group
  • name of the group
  • parentGroup parent group (may be nil)
• Working with dimensions
  • addDimension Add a new coordinate dimension and associated coordinate variable.
  • dimensionPathWithName Return the full group-qualified path of a dimension name.
  • dimensionWithID Retrieve dimensions by NetCDF dimension ID.
  • dimensions array of NetCDFDimension objects
  • hasDimensionWithName Determine whether a dimension exists in this group.
• Working with variables
  • addFunctionHandle Add a lazily-evaluated variable backed by a function handle.
  • addVariable Add a real or complex variable to the group.
  • complexVariables array of NetCDFComplexVariable objects
  • readVariables Read one or more variables from file.
  • readVariablesAtIndexAlongDimension Read variables at a single index along a named dimension.
  • realVariables array of NetCDFVariable objects
  • variablePathsWithName Return all group-qualified paths matching a variable name.
  • variableWithName Retrieve a variable by name or path.
• Working with groups
  • addDuplicateGroup Duplicate an existing group into this group.
  • addGroup Create a new child group.
  • groupPath path of group
  • groupWithName Retrieve a child group by name.
  • groups array of NetCDFGroup objects
  • hasGroupWithName Determine whether a child group exists in this group.
• Working with global attributes
  • addAttribute Add or replace a global attribute on this group.
  • attributes key-value Map of group attributes
  • hasAttributeWithName Determine whether a global attribute exists on this group.
• Other
  • dimensionWithName Retrieve a dimension by name.
  • hasVariableWithName Determine whether a variable exists in this group.

---