NetcdfTypedComponent Class Reference

A base class used to derive NetcdfAttribute and NetcdfVariable. More...

#import <NetcdfTypedComponent.h>

Inherited by NetcdfAttribute, and NetcdfVariable.

Collaboration diagram for NetcdfTypedComponent:

Collaboration graph
[legend]

List of all members.

Public Member Functions

(id) - init
 Default initializer is just a stub for a subclass; do not use it directly.
(id) - owner
 NetcdfDataset that owns this object.
(size_t) - countData
 Returns the number of data elements in object.
(nc_type) - ncType
 data type as defined in netCDF.
(NSString *) - type
 data type as a string description
(NSString *) - name
 name of object
(BOOL) - isValid
 returns YES after a successful initialization
(int) - ncErrNo
 return code from last netCDF library call
(NSMutableDictionary *) - schema
 structure of object; re-implemented in the subclasses

Protected Attributes

NetcdfDatasetowner
 NetcdfDataset that owns this object.
char cname [NC_MAX_NAME]
 C string of name.
nc_type ncType
 data type
const char * objCTypeCode
 ObjC code for data type.
size_t countData
 number of data elements
BOOL isValid
 set to YES after a valid initialization in a subclass
int ncErrNo
 return value for last netCDF library call


Detailed Description

A base class used to derive NetcdfAttribute and NetcdfVariable.

Do not use the NetcdfTypedComponent class directly. Use one of its subclasses NetcdfAttribute or NetcdfVariable. The owner object will create and initialize them as needed.


Member Function Documentation

- (size_t) countData  

Returns the number of data elements in object.

This value is fixed by the netCDF file structure in the case of attributes or ordinary variables. Variables with an unlimited dimension can have their size changed.

In NetcdfVariable, this is overridden to recompute the value at every invocation. The ivar countData is a cached copy and becomes stale if the unlimited dimension changes size.

- (nc_type) ncType  

data type as defined in netCDF.

Defined data types are: NC_BYTE, NC_CHAR, NC_SHORT, NC_INT, NC_FLOAT, and NC_DOUBLE. (As of netCDF 3.6.2 there is no support for 64-bit long-long int.)

- (NSMutableDictionary *) schema  

structure of object; re-implemented in the subclasses

key: "name" value: NSString attribute/variable name
key: "type" value: NSNumber attribute/variable data type (nc_type)

Reimplemented in NetcdfAttribute, and NetcdfVariable.


Generated on Thu Sep 24 23:22:19 2009 for NetcdfStep by  doxygen 1.5.7.1