NetcdfDimension Class Reference
Associates a name string to the length of an array dimension. More...
#import <NetcdfDimension.h>
Public Member Functions | |
| (id) | - init |
| A stub; real method is -initByOwner:dimid:. | |
| (id) | - initByOwner:dimid: |
| Called from an instance of NetcdfDataset that owns the dimension during its initialization. | |
| (id) | - owner |
| Returns the NetcdfDataset. | |
| (NSString *) | - name |
| Returns the human-readable name of dimension. | |
| (size_t) | - length |
| Returns length of an array dimension. | |
| (BOOL) | - isValid |
| Returns YES if initialization was successful. | |
| (BOOL) | - isUnlimited |
| Returns YES if this is the unlimited dimension. | |
| (int) | - ncErrNo |
| Return value of certain netCDF library calls related to dimensions. | |
| (NSError *) | - lastError |
| Return an autoreleased NSError report on the last error, or nil if no error. | |
| (NSMutableDictionary *) | - schema |
| Structure of the dimension object. | |
Protected Attributes | |
| NetcdfDataset * | owner |
| NetcdfDataset that owns this dimension. | |
| NSMutableString * | name |
| Name by which the dimension is known. | |
| size_t | length |
| Array dimension. | |
| BOOL | isValid |
| set to YES on a successful initialization | |
| BOOL | isUnlimited |
| set to YES for an unbounded array dimension | |
| int | ncErrNo |
| return value of certain netCDF library calls | |
Detailed Description
Associates a name string to the length of an array dimension.These are objects owned by a NetcdfDataset, and stored in an array. They have a name and a length. The netCDF-3 standard allows at most one to have isUnlimited = YES to indicate an unbounded dimension. A NetcdfVariable has an array of references to the dimension objects that describe its data space; if one dimension is unlimited, it must be at index 0.
NetcdfDimension objects are created and managed by NetcdfDataset; you should not normally need to instantiate them.
Member Function Documentation
| - (id) init |
A stub; real method is -initByOwner:dimid:.
Returns a truncated object and sets isValid = NO.
| - (id) initByOwner: | (NetcdfDataset *) | newOwner | ||
| dimid: | (int) | newDimid | ||
Called from an instance of NetcdfDataset that owns the dimension during its initialization.
The dimid variable is obtained internally from the netCDF library.
On failure, sets isValid = NO and returns an error code in ncErrNo.
| - (NSError *) lastError |
Return an autoreleased NSError report on the last error, or nil if no error.
The NSError will have the code set to ncErrNo, domain set to "netCDF" and its userInfo dictionary will contain:
key: NSLocalizedDescription value: NSString human readable error message
key: "path" value: NSString path to the netCDF data file
key: "class" value: NSString "NetcdfDimension"
key: "name" value: NSString name of dimension
| - (size_t) length |
Returns length of an array dimension.
For normal dimensions, this value is fixed by the structure of the netCDF dataset. For the unlimited dimension, the value is the current size based on the amount of data actually written to the dataset; this can change. Sets ncErrNo.
| - (NSMutableDictionary *) schema |
Structure of the dimension object.
key: "name" value: NSString dimension name string
key: "length" value: NSNumber unsigned int dimension length
Note that the length of an unlimited dimension is set to NC_UNLIMITED, not the current number of data which may change without notice.
