libcds3  1.10
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Functions
Print Functions

Functions

int cds_print (FILE *fp, CDSGroup *group, int flags)
 Print CDS.
int cds_print_att (FILE *fp, const char *indent, int min_width, CDSAtt *att)
 Print a CDS Attribute.
int cds_print_atts (FILE *fp, const char *indent, void *parent)
 Print CDS Attributes.
int cds_print_dim (FILE *fp, const char *indent, int min_width, CDSDim *dim)
 Print a CDS Dimension.
int cds_print_dims (FILE *fp, const char *indent, CDSGroup *group)
 Print CDS Dimensions.
int cds_print_var (FILE *fp, const char *indent, CDSVar *var, int flags)
 Print a CDS Variable.
int cds_print_vars (FILE *fp, const char *indent, CDSGroup *group, int flags)
 Print CDS Variables.
int cds_print_var_data (FILE *fp, const char *label, const char *indent, CDSVar *var)
 Print CDS Variable Data.
int cds_print_data (FILE *fp, const char *indent, CDSGroup *group)
 Print CDS Data.
int cds_print_group (FILE *fp, const char *indent, CDSGroup *group, int flags)
 Print CDS Group.
int cds_print_groups (FILE *fp, const char *indent, CDSGroup *group, int flags)
 Print CDS Groups.
int cds_print_vararray (FILE *fp, const char *indent, CDSVarArray *vararray, int flags)
 Print CDS Variable Array.
int cds_print_vargroup (FILE *fp, const char *indent, CDSVarGroup *vargroup, int flags)
 Print CDS Variable Group.
int cds_print_vargroups (FILE *fp, const char *indent, CDSGroup *group, int flags)
 Print CDS Variable Groups.

Detailed Description

Function Documentation

int cds_print ( FILE *  fp,
CDSGroup *  group,
int  flags 
)

Print CDS.

By default (flags = 0) this function will print all dimensions, attributes, variables, groups, and data in the specified group.

Control Flags:

  • CDS_SKIP_GROUP_ATTS = do not print group attributes
  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_DATA = do not print variable data
  • CDS_SKIP_SUBGROUPS = do not print subgroups
Parameters:
fp- pointer to the open file to print to
group- pointer to the group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 271 of file cds_print.c.

int cds_print_att ( FILE *  fp,
const char *  indent,
int  min_width,
CDSAtt *  att 
)

Print a CDS Attribute.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
min_width- the minimum width used to print the attribute name
att- pointer to the attribute
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 291 of file cds_print.c.

int cds_print_atts ( FILE *  fp,
const char *  indent,
void *  parent 
)

Print CDS Attributes.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
parent- pointer to the parent group or variable
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 341 of file cds_print.c.

int cds_print_data ( FILE *  fp,
const char *  indent,
CDSGroup *  group 
)

Print CDS Data.

This function will print the data for all the variables in the specified group.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the group
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 726 of file cds_print.c.

int cds_print_dim ( FILE *  fp,
const char *  indent,
int  min_width,
CDSDim *  dim 
)

Print a CDS Dimension.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
min_width- the minimum width used to print the dimension name
dim- pointer to the dimension
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 408 of file cds_print.c.

int cds_print_dims ( FILE *  fp,
const char *  indent,
CDSGroup *  group 
)

Print CDS Dimensions.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the group
Returns:
  • number of bytes printed
  • negative value if an output error occurred

Definition at line 440 of file cds_print.c.

int cds_print_group ( FILE *  fp,
const char *  indent,
CDSGroup *  group,
int  flags 
)

Print CDS Group.

By default (flags = 0) this function will print all dimensions, attributes, variables, groups, and data in the specified group.

Control Flags:

  • CDS_SKIP_DIMS = do not print dimensions
  • CDS_SKIP_GROUP_ATTS = do not print group attributes
  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_VARS = do not print variables
  • CDS_SKIP_DATA = do not print variable data
  • CDS_SKIP_SUBGROUPS = do not traverse subgroups
  • CDS_PRINT_VARGROUPS = print variable groups
Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 783 of file cds_print.c.

int cds_print_groups ( FILE *  fp,
const char *  indent,
CDSGroup *  group,
int  flags 
)

Print CDS Groups.

This function will print all supgroups under the specified group.

By default (flags = 0) this function will print all dimensions, attributes, variables, groups, and data in the subgroups.

Control Flags:

  • CDS_SKIP_DIMS = do not print dimensions
  • CDS_SKIP_GROUP_ATTS = do not print group attributes
  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_VARS = do not print variables
  • CDS_SKIP_DATA = do not print variable data
  • CDS_SKIP_SUBGROUPS = do not traverse subgroups
  • CDS_PRINT_VARGROUPS = print variable groups
Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 952 of file cds_print.c.

int cds_print_var ( FILE *  fp,
const char *  indent,
CDSVar *  var,
int  flags 
)

Print a CDS Variable.

By default (flags = 0) all variable attributes will also be printed.

Control Flags:

  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_DATA = do not print variable data
Parameters:
fp- pointer to the open file to print to
indent- line indent string
var- pointer to the variable
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 493 of file cds_print.c.

int cds_print_var_data ( FILE *  fp,
const char *  indent,
const char *  label,
CDSVar *  var 
)

Print CDS Variable Data.

Parameters:
fp- pointer to the open file to print to
indent- line indent string
label- label to print before the = sign, or NULL to only print the data values
var- pointer to the variable
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 625 of file cds_print.c.

int cds_print_vararray ( FILE *  fp,
const char *  indent,
CDSVarArray *  vararray,
int  flags 
)

Print CDS Variable Array.

By default (flags = 0) this function will print all variables, variable attributes and data in the specified variable array.

Control Flags:

  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_VARS = do not print variables
  • CDS_SKIP_DATA = do not print variable data
Parameters:
fp- pointer to the open file to print to
indent- line indent string
vararray- pointer to the variable group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 1000 of file cds_print.c.

int cds_print_vargroup ( FILE *  fp,
const char *  indent,
CDSVarGroup *  vargroup,
int  flags 
)

Print CDS Variable Group.

By default (flags = 0) this function will print all variables, variable attributes and data in the specified variable group.

Control Flags:

  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_VARS = do not print variables
  • CDS_SKIP_DATA = do not print variable data
Parameters:
fp- pointer to the open file to print to
indent- line indent string
vargroup- pointer to the variable group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 1099 of file cds_print.c.

int cds_print_vargroups ( FILE *  fp,
const char *  indent,
CDSGroup *  group,
int  flags 
)

Print CDS Variable Groups.

By default (flags = 0) this function will print all variables, variable attributes and data for the variable groups in the specified CDS group.

Control Flags:

  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_VARS = do not print variables
  • CDS_SKIP_DATA = do not print variable data
Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the variable group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 1168 of file cds_print.c.

int cds_print_vars ( FILE *  fp,
const char *  indent,
CDSGroup *  group,
int  flags 
)

Print CDS Variables.

By default (flags = 0) all variable attributes will also be printed.

Control Flags:

  • CDS_SKIP_VAR_ATTS = do not print variable attributes
  • CDS_SKIP_DATA = do not print variable data
Parameters:
fp- pointer to the open file to print to
indent- line indent string
group- pointer to the group
flags- control flags
Returns:
  • number of bytes printed
  • negative value if an error occurred

Definition at line 584 of file cds_print.c.