cds_dims.c cds3.h cds_private.h stdarg.h cds_private.h stdlib.h limits.h sys/types.h string.h cds3.h cds_dims.c time.h messenger.h stdio.h CDSDim * CDSDim* _cds_create_dim (CDSGroup *group, const char *name, size_t length, int is_unlimited) _cds_create_dim CDSGroup * group const char * name size_t length int is_unlimited PRIVATE: Create a CDS Dimension. Private function used to create a dimension. group - pointer to the parent group name - dimension name length - dimension length (ignored if is_unlimited == TRUE) is_unlimited - specifies if this dimension is unlimited (0 = FALSE, 1 = TRUE) a new dimensionNULL if a memory allocation error occurred void void _cds_destroy_dim (CDSDim *dim) _cds_destroy_dim CDSDim * dim PRIVATE: Destroy a CDS Dimension. Private function used to destroy a dimension. dim - pointer to the dimension int int _cds_is_dim_used (CDSGroup *group, CDSDim *dim) _cds_is_dim_used CDSGroup * group CDSDim * dim PRIVATE: Check if a CDS Dimension is in use. Private function used to check if data has been added to a variable using this dimension. group - pointer to the group the dimension belongs to dim - pointer to the dimension 1 if the dimension is being used0 if the dimesnion is not being used. void void _cds_delete_dependant_vars (CDSGroup *group, CDSDim *dim) _cds_delete_dependant_vars CDSGroup * group CDSDim * dim PRIVATE: Delete dependant variables. Private function used to delete all variables that use the specifed dimension. group - pointer to the group the dimension belongs to dim - pointer to the dimension int int cds_change_dim_length (CDSDim *dim, size_t length) cds_change_dim_length CDSDim * dim size_t length Change the length of a CDS Dimension. Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()). dim - pointer to the dimension length - new dimension length 1 if: the dimension length was changedthe new length was equal to the old lengththis is an unlimited dimension 0 if: the dimension is lockeddata has already been added to a variable using this dimension CDSDim * CDSDim* cds_define_dim (CDSGroup *group, const char *name, size_t length, int is_unlimited) cds_define_dim CDSGroup * group const char * name size_t length int is_unlimited Define a CDS Dimension. This function will first check if a dimension with the same definition already exists in the specified group. If it does, the existing dimension will be returned.Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()). group - pointer to the group name - dimension name length - dimension length is_unlimited - is dimension unlimited (0 = FALSE, 1 = TRUE) pointer to the dimensionNULL if: a static dimension with the same name but different length has already been defined for the specified group.the group is lockeda memory allocation error occurred int int cds_delete_dim (CDSDim *dim) cds_delete_dim CDSDim * dim Delete a CDS Dimension. This function will also delete all variables that use the specified dimension.Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()). dim - pointer to the dimension 1 if the dimension was deleted0 if: the dimension is lockedthe group is locked CDSDim * CDSDim* cds_get_dim (CDSGroup *group, const char *name) cds_get_dim CDSGroup * group const char * name Get a CDS Dimension. This function will search the specified group then and all ancestor groups for a dimension with the specified name. The first dimension found will be returned. group - pointer to the group name - name of the dimension pointer to the dimensionNULL if not found CDSVar * CDSVar* cds_get_dim_var (CDSDim *dim) cds_get_dim_var CDSDim * dim Get the coordinate variable for a CDS Dimension. dim - pointer to the dimension pointer to the coordinate variableNULL if not found int int cds_rename_dim (CDSDim *dim, const char *name) cds_rename_dim CDSDim * dim const char * name Rename a CDS Dimension. This function will also rename the coordinate variable for the dimension if one exists.Error messages from this function are sent to the message handler (see msngr_init_log() and msngr_init_mail()). dim - pointer to the dimension name - pointer to the new dimension name 1 if the dimension was deleted0 if: a dimension with the new name already existsthe dimension is lockedthe group is lockedthe coordinate variable could not be renamed (see cds_rename_var())a memory allocation error occured CDS Dimensions. /******************************************************************************* * *COPYRIGHT(C)2010BattelleMemorialInstitute.AllRightsReserved. * ******************************************************************************** * *Author: *name:BrianErmold *phone:(509)375-2277 *email:brian.ermold@pnl.gov * ******************************************************************************** * *REPOSITORYINFORMATION: *$Revision:9749$ *$Author:ermold$ *$Date:2011-12-0120:22:48+0000(Thu,01Dec2011)$ * ******************************************************************************** * *NOTE:DOXYGENisusedtogeneratedocumentationforthisfile. * *******************************************************************************/ /**@filecds_dims.c *CDSDimensions. */ #include"cds3.h" #include"cds_private.h" /******************************************************************************* *PrivateFunctions */ /**@privatesection*/ /** *PRIVATE:CreateaCDSDimension. * *Privatefunctionusedtocreateadimension. * *@paramgroup-pointertotheparentgroup *@paramname-dimensionname *@paramlength-dimensionlength *(ignoredifis_unlimited==TRUE) *@paramis_unlimited-specifiesifthisdimensionisunlimited *(0=FALSE,1=TRUE) *@return *-anewdimension *-NULLifamemoryallocationerroroccurred */ CDSDim*_cds_create_dim( CDSGroup*group, constchar*name, size_tlength, intis_unlimited) { CDSDim*dim; dim=(CDSDim*)calloc(1,sizeof(CDSDim)); if(!dim){ return((CDSDim*)NULL); } if(!_cds_init_object_members(dim,CDS_DIM,group,name)){ free(dim); return((CDSDim*)NULL); } dim->length=(is_unlimited)?0:length; dim->is_unlimited=is_unlimited; return(dim); } /** *PRIVATE:DestroyaCDSDimension. * *Privatefunctionusedtodestroyadimension. * *@paramdim-pointertothedimension */ void_cds_destroy_dim(CDSDim*dim) { if(dim){ _cds_free_object_members(dim); free(dim); } } /** *PRIVATE:CheckifaCDSDimensionisinuse. * *Privatefunctionusedtocheckifdatahasbeenaddedtoavariable *usingthisdimension. * *@paramgroup-pointertothegroupthedimensionbelongsto *@paramdim-pointertothedimension * *@return *-1ifthedimensionisbeingused *-0ifthedimesnionisnotbeingused. */ int_cds_is_dim_used(CDSGroup*group,CDSDim*dim) { CDSVar*var; intvi,di,gi; /*Searchthevariablesinthisgroup*/ for(vi=0;vi<group->nvars;vi++){ var=group->vars[vi]; if(var->data.vp){ for(di=0;di<var->ndims;di++){ if(var->dims[di]==dim){ return(1); } } } } /*Recurseintosub-groups*/ for(gi=0;gi<group->ngroups;gi++){ if(_cds_is_dim_used(group->groups[gi],dim)){ return(1); } } return(0); } /** *PRIVATE:Deletedependantvariables. * *Privatefunctionusedtodeleteallvariablesthatusethe *specifeddimension. * *@paramgroup-pointertothegroupthedimensionbelongsto *@paramdim-pointertothedimension */ void_cds_delete_dependant_vars(CDSGroup*group,CDSDim*dim) { CDSVar*var; intvi,di,gi; /*Searchthevariablesinthisgroup*/ for(vi=0;vi<group->nvars;vi++){ var=group->vars[vi]; for(di=0;di<var->ndims;di++){ if(var->dims[di]==dim){ _cds_remove_object((void**)group->vars,&(group->nvars),var); _cds_destroy_var(var); vi--; break; } } } /*Recurseintosub-groups*/ for(gi=0;gi<group->ngroups;gi++){ _cds_delete_dependant_vars(group->groups[gi],dim); } } /******************************************************************************* *PublicFunctions */ /**@publicsection*/ /** *ChangethelengthofaCDSDimension. * *Errormessagesfromthisfunctionaresenttothemessagehandler *(seemsngr_init_log()andmsngr_init_mail()). * *@paramdim-pointertothedimension *@paramlength-newdimensionlength * *@return *-1if: *-thedimensionlengthwaschanged *-thenewlengthwasequaltotheoldlength *-thisisanunlimiteddimension *-0if: *-thedimensionislocked *-datahasalreadybeenaddedtoavariableusingthisdimension */ intcds_change_dim_length(CDSDim*dim,size_tlength) { CDSGroup*group=(CDSGroup*)dim->parent; /*Checkifthenewlengthequalstheoldlength*/ if(dim->length==length){ return(1); } /*Checkifthisisanunlimiteddimension.*/ if(dim->is_unlimited){ return(1); } /*Checkifthedimensionislocked*/ if(dim->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotchangedimensionlengthfor:%s\n" "->thedimensiondefinitionlockissetto:%d\n", cds_get_object_path(dim),dim->def_lock); return(0); } /*Thedimensionsizecannotbechangedifdatahasbeenadded *toavariableusingthisdimension. */ if(_cds_is_dim_used(group,dim)){ ERROR(CDS_LIB_NAME, "Couldnotchangedimensionlengthfor:%s\n" "->datahasbeenaddedforavariableusingthisdimension\n", cds_get_object_path(dim)); return(0); } /*Changethedimensionlength*/ dim->length=length; return(1); } /** *DefineaCDSDimension. * *Thisfunctionwillfirstcheckifadimensionwiththesame *definitionalreadyexistsinthespecifiedgroup.Ifitdoes, *theexistingdimensionwillbereturned. * *Errormessagesfromthisfunctionaresenttothemessagehandler *(seemsngr_init_log()andmsngr_init_mail()). * *@paramgroup-pointertothegroup *@paramname-dimensionname *@paramlength-dimensionlength *@paramis_unlimited-isdimensionunlimited(0=FALSE,1=TRUE) * *@return *-pointertothedimension *-NULLif: *-astaticdimensionwiththesamenamebutdifferentlength *hasalreadybeendefinedforthespecifiedgroup. *-thegroupislocked *-amemoryallocationerroroccurred */ CDSDim*cds_define_dim( CDSGroup*group, constchar*name, size_tlength, intis_unlimited) { CDSDim*dim; CDSDim**dims; /*Checkifadimensionwiththisnamealreadyexists*/ dim=_cds_get_object((void**)group->dims,group->ndims,name); if(dim){ if((is_unlimited==dim->is_unlimited)&& (is_unlimited||(length==dim->length))){ return(dim); } /*Adimensionwiththisnamebutadifferentdefinition *hasalreadybeendefinedforthisgroup*/ ERROR(CDS_LIB_NAME, "Couldnotdefinedimension:%s\n" "->dimensionexists\n",cds_get_object_path(dim)); return((CDSDim*)NULL); } /*Checkifthegroupislocked*/ if(group->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotdefinedimension:%s/_dims_/%s\n" "->thegroupdefinitionlockissetto:%d\n", cds_get_object_path(group),name,group->def_lock); return((CDSDim*)NULL); } /*Allocatespaceforanewdimension*/ dims=(CDSDim**)realloc( group->dims,(group->ndims+2)*sizeof(CDSDim*)); if(!dims){ ERROR(CDS_LIB_NAME, "Couldnotdefinedimension:%s/_dims_/%s\n" "->memoryallocationerror\n", cds_get_object_path(group),name); return((CDSDim*)NULL); } group->dims=dims; /*Createthedimension*/ group->dims[group->ndims]=_cds_create_dim( group,name,length,is_unlimited); if(!group->dims[group->ndims]){ ERROR(CDS_LIB_NAME, "Couldnotdefinedimension:%s/_dims_/%s\n" "->memoryallocationerror\n", cds_get_object_path(group),name); return((CDSDim*)NULL); } group->ndims++; group->dims[group->ndims]=(CDSDim*)NULL; return(group->dims[group->ndims-1]); } /** *DeleteaCDSDimension. * *Thisfunctionwillalsodeleteallvariablesthatusethe *specifieddimension. * *Errormessagesfromthisfunctionaresenttothemessagehandler *(seemsngr_init_log()andmsngr_init_mail()). * *@paramdim-pointertothedimension * *@return *-1ifthedimensionwasdeleted *-0if: *-thedimensionislocked *-thegroupislocked */ intcds_delete_dim(CDSDim*dim) { CDSGroup*group=(CDSGroup*)dim->parent; /*Checkifthedimensionislocked*/ if(dim->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotdeletedimension:%s\n" "->thedimensiondefinitionlockissetto:%d\n", cds_get_object_path(dim),dim->def_lock); return(0); } /*Checkifthegroupislocked*/ if(group->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotdeletedimension:%s\n" "->thegroupdefinitionlockissetto:%d\n", cds_get_object_path(dim),group->def_lock); return(0); } /*Deletevariablesusingthisdimension*/ _cds_delete_dependant_vars(group,dim); /*Removethisdimensionfromthegroup*/ _cds_remove_object((void**)group->dims,&(group->ndims),dim); /*Destroythedimension*/ _cds_destroy_dim(dim); return(1); } /** *GetaCDSDimension. * *Thisfunctionwillsearchthespecifiedgroupthenandall *ancestorgroupsforadimensionwiththespecifiedname. *Thefirstdimensionfoundwillbereturned. * *@paramgroup-pointertothegroup *@paramname-nameofthedimension * *@return *-pointertothedimension *-NULLifnotfound */ CDSDim*cds_get_dim(CDSGroup*group,constchar*name) { CDSDim*dim; dim=_cds_get_object((void**)group->dims,group->ndims,name); if(!dim&&group->parent){ dim=cds_get_dim((CDSGroup*)group->parent,name); } return(dim); } /** *GetthecoordinatevariableforaCDSDimension. * *@paramdim-pointertothedimension * *@return *-pointertothecoordinatevariable *-NULLifnotfound */ CDSVar*cds_get_dim_var(CDSDim*dim) { return(cds_get_var((CDSGroup*)dim->parent,dim->name)); } /** *RenameaCDSDimension. * *Thisfunctionwillalsorenamethecoordinatevariableforthe *dimensionifoneexists. * *Errormessagesfromthisfunctionaresenttothemessagehandler *(seemsngr_init_log()andmsngr_init_mail()). * *@paramdim-pointertothedimension *@paramname-pointertothenewdimensionname * *@return *-1ifthedimensionwasdeleted *-0if: *-adimensionwiththenewnamealreadyexists *-thedimensionislocked *-thegroupislocked *-thecoordinatevariablecouldnotberenamed(seecds_rename_var()) *-amemoryallocationerroroccured */ intcds_rename_dim(CDSDim*dim,constchar*name) { CDSGroup*group=(CDSGroup*)dim->parent; CDSVar*coord_var; char*new_name; /*Checkifadimensionwiththenewnamealreadyexists*/ if(cds_get_dim(group,name)){ ERROR(CDS_LIB_NAME, "Couldnotrenamedimension:%sto%s\n" "->dimensionexists\n", cds_get_object_path(dim),name); return(0); } /*Checkifthedimensionislocked*/ if(dim->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotrenamedimension:%sto%s\n" "->thedimensiondefinitionlockissetto:%d\n", cds_get_object_path(dim),name,dim->def_lock); return(0); } /*Checkifthegroupislocked*/ if(group->def_lock){ ERROR(CDS_LIB_NAME, "Couldnotrenamedimension:%sto%s\n" "->thegroupdefinitionlockissetto:%d\n", cds_get_object_path(dim),name,group->def_lock); return(0); } /*Createthenewdimensionname*/ new_name=strdup(name); if(!new_name){ ERROR(CDS_LIB_NAME, "Couldnotrenamedimension:%sto%s\n" "->memoryallocationerror\n", cds_get_object_path(dim),name); return(0); } /*Renamethecoordinatevariableifoneexists*/ coord_var=cds_get_dim_var(dim); if(coord_var){ if(!cds_rename_var(coord_var,new_name)){ return(0); } } /*Renamethedimension*/ free(dim->name); dim->name=new_name; return(1); }