Main Page | Modules | Files | Functions | Code Elements | Data Structures | Deprecated

Dataset
[Application Encapsulation]

Detailed Description

A complete list of named references defined for a tool may not necessarily exist in all instances of datasets created by that tool or datasets that can be read by that tool.

Warning:
Do not pass the const char reference_name[AE_reference_size_c + 1] argument to AE_add_dataset_named_ref or AE_remove_dataset_named_ref by handing to them a character pointer which points to a reference name and which is returned by another Teamcenter Engineering routine (like a pointer returned by AE_ask_dataset_named_ref or by other ITK routines). Unpredictable results can happen this way which can be difficult to trace down. We strongly recommend that you always make a copy of the reference name into a local character array before passing it to these two ITK functions as follows:
    your_ITK_routine()
    {
        char my_local_copy_refname[AE_reference_size_c + 1];
        char my_other_refname[AE_reference_size_c + 1];

        tag_t my_dataset;
        tag_t my_other_dataset;

        AE_reference_type_t my_ref_type;
        AE_reference_type_t my_other_ref_type;

        tag_t my_ref_object;
        tag_t my_other_ref_object;

        .... other stuff ...

        strcpy(my_local_copy_refname, "UGPART");
        AE_add_dataset_named_ref(my_dataset, my_local_copy_refname, myref_type, my_ref_object);

        strcpy(my_local_copy_refname, "CLS");
        AE_add_dataset_named_ref(my_dataset, my_local_copy_refname, my_other_ref_type, my_other_ref_object);

        .... other stuff ...

        strcpy(my_other_refname, "EXPERT");
        AE_ask_dataset_named_ref(my_other_dataset, my_other_refname, & my_other_ref_type, & my_other_ref_object);

        strcpy(my_local_copy_refname, my_other_refname);
        AE_add_dataset_named_ref(my_dataset, my_local_copy_refname, my_other_ref_type, my_other_ref_object);

        .... other stuff ...

        strcpy(my_local_copy_refname, "UGPART");
        AE_remove_dataset_named_ref(my_dataset, my_local_copy_refname);

        .... other stuff ...

    }

AE_reference_type_t can be either AE_ASSOCIATION or AE_PART_OF.

Modules

Revision Anchor

Dataset Identification

Typedefs

Enumerations

Functions

Typedef Documentation

typedef enum AE_reference_type_e AE_reference_type_t

Enumeration Type Documentation

enum AE_reference_type_e

Enumerator:
AE_BAD_REF_TYPE 
AE_ASSOCIATION  Referenced objects are not a logical part of the dataset and will not be deleted with the dataset.
AE_PART_OF  Referenced objects are an integral part of the dataset and will be deleted with the dataset.

Definition at line 86 of file dataset.h.

Function Documentation

AE_API int AE_add_dataset_named_ref ( tag_t  dataset,
const char  reference_name[AE_reference_size_c+1],
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_add_dataset_named_ref2
Adds named references to datasets.
Parameters:
dataset  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_add_dataset_named_ref2 ( tag_t  dataset,
const char *  reference_name,
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

Adds named references to datasets.

Parameters:
dataset  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_ask_all_dataset_named_refs ( tag_t  dataset,
const char  reference_name[AE_reference_size_c+1],
int *  nFound,
tag_t **  referenced_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_all_dataset_named_refs2
This function finds all the named reference objects of the dataset dsTag that match the name refName.
Parameters:
dataset  (I) Tag of the dataset that owns the named reference objects.
reference_name  (I) Name being used for searching the named reference objects in the database.
nFound  (O) Total number of tags that are found (i.e., the total number of elements in the output tag list refObjs). nFound will be 0 if there is no match.
referenced_object  (OF) nFound A pointer to an array of tags. They are the tags of all the named reference objects of dataset dsTag that match the input name refName. Content of refObjs (i.e., in C, that means *refObjs) will be NULL if there is no match. Also, the user is responsible to free the done (hence, the notation (OF)).

AE_API int AE_ask_all_dataset_named_refs2 ( tag_t  dataset,
const char *  reference_name,
int *  nFound,
tag_t **  referenced_object 
)

This function finds all the named reference objects of the dataset dsTag that match the name refName.

Parameters:
dataset  (I) Tag of the dataset that owns the named reference objects.
reference_name  (I) Name being used for searching the named reference objects in the database.
nFound  (O) Total number of tags that are found (i.e., the total number of elements in the output tag list refObjs). nFound will be 0 if there is no match.
referenced_object  (OF) nFound A pointer to an array of tags. They are the tags of all the named reference objects of dataset dsTag that match the input name refName. Content of refObjs (i.e., in C, that means *refObjs) will be NULL if there is no match. Also, the user is responsible to free the done (hence, the notation (OF)).

AE_API int AE_ask_dataset ( tag_t  dataset,
tag_t *  lastDataset 
)

Returns the Tag of the latest version of the specified dataset (version0).

Parameters:
dataset  (I) Specified dataset being used for getting its latest version.
lastDataset  (O) Tag of the latest version being returned. (version0)

AE_API int AE_ask_dataset_anchor ( tag_t  dataset,
tag_t *  revision_anchor 
)

Returns the revision anchor for any revision of a dataset. The anchor can be used to perform more sophisticated revisioning tasks on a dataset.

Parameters:
dataset  (I)
revision_anchor  (O)

AE_API int AE_ask_dataset_at ( tag_t  dataset,
int  index_name,
tag_t *  outDataset 
)

Returns the Tag of the dataset based on the creation order you specified (i.e., first dataset, second dataset, third dataset, ... N(th) dataset). Notice that the index is relative to 1.

If you have dataset versions: 1, 2, 3, 4 and 5, then an index of 4 returns dataset version 4.

If you have dataset versions: 1, 5, 7, 90 and 99, then an index of 4 returns dataset version 90.

Parameters:
dataset  (I) Tag of the input dataset.
index_name  (I) Index to locate the desired dataset version.
outDataset  (O) Tag of the desired dataset version.

AE_API int AE_ask_dataset_datasettype ( tag_t  dataset,
tag_t *  datasettype 
)

Returns the datasettype attribute for the input dataset.

Parameters:
dataset  (I)
datasettype  (O)

AE_API int AE_ask_dataset_def_rev_limit ( int *  default_rev_limit  ) 

Returns the default revision limit for newly created datasets as set by the system administrator. This value is in the AE_dataset_default_keep_limit preference.

Parameters:
default_rev_limit  (O)

AE_API int AE_ask_dataset_first_rev ( tag_t  dataset,
tag_t *  firstDataset 
)

Returns the Tag of the oldest version (i.e., version 1) of the specified dataset.

Parameters:
dataset  (I) Specified dataset being used for getting its oldest version.
firstDataset  (O) Tag of the oldest version (i.e., version 1) being returned.

AE_API int AE_ask_dataset_format ( tag_t  dataset,
char  format_name[AE_io_format_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_dataset_format2
Returns the format attribute for the input dataset.
Parameters:
dataset  (I)
format_name  (O)

AE_API int AE_ask_dataset_format2 ( tag_t  dataset,
char **  format_name 
)

Returns the format attribute for the input dataset.

Parameters:
dataset  (I)
format_name  (OF)

AE_API int AE_ask_dataset_id_rev ( tag_t  aDataset,
char **  aDatasetId,
char **  aDatasetRev 
)

This function finds the id and rev for a specified Dataset tag.

Parameters:
aDataset  (I) The Dataset tag that is used to get the id and rev.
aDatasetId  (OF) The Dataset id that is returned.
aDatasetRev  (OF) The Dataset rev that is returned.

AE_API int AE_ask_dataset_latest_rev ( tag_t  dataset,
tag_t *  latestDataset 
)

Returns the tag of the highest revision dataset.

Parameters:
dataset  (I)
latestDataset  (O)

AE_API int AE_ask_dataset_named_ref ( tag_t  dataset,
const char  reference_name[AE_reference_size_c+1],
AE_reference_type_t *  reference_type,
tag_t *  referenced_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use #
Parameters:
dataset  (I)
reference_name  (I)
reference_type  (O)
referenced_object  (O)

AE_API int AE_ask_dataset_named_ref2 ( tag_t  dataset,
const char *  reference_name,
AE_reference_type_t *  reference_type,
tag_t *  referenced_object 
)

Parameters:
dataset  (I)
reference_name  (I)
reference_type  (O)
referenced_object  (O)

AE_API int AE_ask_dataset_named_refs ( tag_t  dataset,
int *  nFound,
tag_t **  refObject 
)

Parameters:
dataset  (I)
nFound  (O)
refObject  (OF) nFound

AE_API int AE_ask_dataset_next_rev ( tag_t  dataset,
tag_t *  nextDataset 
)

Returns the Tag of the next version relative to the specified dataset.

Parameters:
dataset  (I) Specified dataset being used for getting its next version.
nextDataset  (O) Tag of the next version (i.e., version 1) being returned.

AE_API int AE_ask_dataset_num_revs ( tag_t  dataset,
int *  count 
)

Returns the total number of versions for the specified dataset.

Parameters:
dataset  (I) Tag of the input dataset being used for counting the total number of versions.
count  (O) Total number of versions for the dataset.

AE_API int AE_ask_dataset_prev_rev ( tag_t  dataset,
tag_t *  prevDataset 
)

Returns the Tag of the previous version relative to the specified dataset.

Parameters:
dataset  (I) Specified dataset being used for getting its previous version.
prevDataset  (O) Tag of the previous version (i.e., version 1) being returned.

AE_API int AE_ask_dataset_ref_count ( tag_t  dataset,
int *  reference_count 
)

Parameters:
dataset  (I)
reference_count  (O)

AE_API int AE_ask_dataset_siteclass ( tag_t  dataset,
char  site_classification[AE_siteclass_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_dataset_siteclass2
Returns the site classification attribute for the input dataset.
Parameters:
dataset  (I)
site_classification  (O)

AE_API int AE_ask_dataset_siteclass2 ( tag_t  dataset,
char **  site_classification 
)

Returns the site classification attribute for the input dataset.

Parameters:
dataset  (I)
site_classification  (OF)

AE_API int AE_ask_dataset_tool ( tag_t  dataset,
tag_t *  tool 
)

Returns the tool attribute for the input dataset.

Parameters:
dataset  (I)
tool  (O)

AE_API int AE_copy_dataset ( tag_t  dataset,
const char  name_of_new_dataset[WSO_name_size_c+1],
tag_t *  new_dataset 
)

Deprecated:
This function is deprecated and will be removed from TC2009. Use AE_copy_dataset_with_id instead
Parameters:
dataset  (I)
name_of_new_dataset  (I)
new_dataset  (O)

AE_API int AE_copy_dataset_with_id ( tag_t  aDataset,
const char *  nameOfNewDataset,
const char *  dsId,
const char *  dsRev,
tag_t *  aNewDataset 
)

This function copies a dataset and uses the Dataset tag, the new dataset name, id, and rev.

Parameters:
aDataset  (I) The Dataset tag that is copied.
nameOfNewDataset  (I) The new user-defined Dataset name.
dsId  (I) The new Dataset id that is used.
dsRev  (I) The new Dataset rev that is used.
aNewDataset  (O) The unique identifier of the new dataset is returned.

AE_API int AE_create_dataset ( tag_t  dataset_type,
const char  dataset_name[WSO_name_size_c+1],
const char  dataset_description[WSO_desc_size_c+1],
tag_t *  new_dataset 
)

Deprecated:
This function is deprecated and will be removed from TC2009. Use AE_create_dataset_with_id instead
Parameters:
dataset_type  (I)
dataset_name  (I)
dataset_description  (I)
new_dataset  (O)

AE_API int AE_create_dataset_with_id ( tag_t  aDatasetType,
const char *  aDatasetName,
const char *  aDatasetDescription,
const char *  aDatasetId,
const char *  aDatasetRev,
tag_t *  aNewDataset 
)

This function creates a Dataset by specified type, name, description, id, and rev.

Parameters:
aDatasetType  (I) The Dataset type tag that is being used to create the dataset.
aDatasetName  (I) The new user-defined Dataset name.
aDatasetDescription  (I) The new user-defined Dataset description.
aDatasetId  (I) The Dataset id that is used.
aDatasetRev  (I) The Dataset rev that is used.
aNewDataset  (O) The unique identifier of the new Dataset.

AE_API int AE_create_dataset_with_revanchor ( tag_t  aDatasetType,
const char *  aDatasetName,
const char *  aDatasetDescription,
const char *  aDatasetId,
const char *  aDatasetRev,
tag_t  rev_anchor_tag,
tag_t *  aNewDataset 
)

Deprecated:
This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

AE_API int AE_dataset_extent ( int *  n_instances,
tag_t **  instances 
)

Returns the tags of all of the datasets currently in the database. The memory for datasets should be freed with MEM_free .

Parameters:
n_instances  (O)
instances  (OF) n_instances

AE_API int AE_delete_all_dataset_revs ( tag_t  dataset  ) 

Deletes all revisions of a dataset that are not referenced by some other object in the database. If none of the revisions are referenced, then the dataset and its revision anchor will be removed from the database completely.

Parameters:
dataset  (I)

AE_API int AE_delete_bounding_boxes ( tag_t  dataset  ) 

Deletes boundingBox information for given Dataset.

Parameters:
dataset  (I) tag of Dataset

AE_API int AE_export_named_ref ( tag_t  datasetTag,
const char *  referenceName,
const char *  destPathName 
)

Exports the ImanFile object that is associated with the dataset by named reference.

Parameters:
datasetTag  (I) Tag of the target dataset on or through which the operation is being performed.
referenceName  (I) Name of the reference used for associating the file and dataset.
destPathName  (I) The path to the destination to which the file is copied.

AE_API int AE_find_all_datasets ( const char  dataset_name[WSO_name_size_c+1],
int *  nFound,
tag_t **  dataset 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_find_all_datasets2
Finds all the datasets in the database that match the input name.
Parameters:
dataset_name  (I) Dataset name being used for searching the database.
nFound  (O) Total number of tags that are found (i.e., the total number of elements in the output tag list datasets). nFound will be 0 if there is no match.
dataset  (OF) nFound A pointer to an array of tags. They are the tags of all the dataset versions of all the datasets that match the input name dsName. Content of datasets (i.e., in C, that means *datasets) will be NULL if there is no match.

AE_API int AE_find_all_datasets2 ( const char *  dataset_name,
int *  nFound,
tag_t **  dataset 
)

Finds all the datasets in the database that match the input name.

Parameters:
dataset_name  (I) Dataset name being used for searching the database.
nFound  (O) Total number of tags that are found (i.e., the total number of elements in the output tag list datasets). nFound will be 0 if there is no match.
dataset  (OF) nFound A pointer to an array of tags. They are the tags of all the dataset versions of all the datasets that match the input name dsName. Content of datasets (i.e., in C, that means *datasets) will be NULL if there is no match.

AE_API int AE_find_all_datasets_by_id ( tag_t  aDatasetType,
const char *  aDatasetId,
int *  nFound,
tag_t **  aDataset 
)

This function finds all of the datasets in the database that match the specified Dataset type name and Dataset id.

Parameters:
aDatasetType  (I) The Dataset tag type that is used to search the database.
aDatasetId  (I) The Dataset id that is used.
nFound  (O) The total number of tags that are found (that is, the total number of elements in the output tag list, dataset_tags). The value n_found is 0 if there is no match.
aDataset  (OF) nFound A pointer to an array of tags. These are all of the Dataset tags that match the specified dataset type and id. The content for dataset_tags is NULL if there is no match.

AE_API int AE_find_dataset ( const char  dataset_name[WSO_name_size_c+1],
tag_t *  dataset 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_find_dataset2
Returns the Tag of the dataset with the input name. Dataset names are not necessarily unique. This function always returns the Tag of the latest revision. Use the revision anchor to get the precise dataset desired. When the dataset is found, it will not be loaded for modify. Call AOM_refresh or AOM_lock to set it for modify. For more complicated searches, use WSOM_search .
Parameters:
dataset_name  (I)
dataset  (O)

AE_API int AE_find_dataset2 ( const char *  dataset_name,
tag_t *  dataset 
)

Returns the Tag of the dataset with the input name. Dataset names are not necessarily unique. This function always returns the Tag of the latest revision. Use the revision anchor to get the precise dataset desired. When the dataset is found, it will not be loaded for modify. Call AOM_refresh or AOM_lock to set it for modify. For more complicated searches, use WSOM_search .

Parameters:
dataset_name  (I)
dataset  (O)

AE_API int AE_find_dataset_by_id_rev ( tag_t  aDatasetType,
const char *  aDatasetId,
const char *  aDatasetRev,
tag_t *  aDataset 
)

This function returns the Dataset tag, type, id, and rev that matches the specified id and rev.

Parameters:
aDatasetType  (I) The dataset type tag used to search the database.
aDatasetId  (I) The Dataset id that is used.
aDatasetRev  (I) The Dataset rev that is used.
aDataset  (O) The returned Dataset tag.

AE_API int AE_find_dataset_named_ref ( tag_t  dataset,
int  instance,
char  reference_name[AE_reference_size_c+1],
AE_reference_type_t *  reference_type,
tag_t *  referenced_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_find_dataset_named_ref2
Finds named references in datasets.
Parameters:
dataset  (I)
instance  (I)
reference_name  (O)
reference_type  (O)
referenced_object  (O)

AE_API int AE_find_dataset_named_ref2 ( tag_t  dataset,
int  instance,
char **  reference_name,
AE_reference_type_t *  reference_type,
tag_t *  referenced_object 
)

Finds named references in datasets.

Parameters:
dataset  (I)
instance  (I)
reference_name  (OF)
reference_type  (O)
referenced_object  (O)

AE_API int AE_get_bounding_boxes ( tag_t  dataset,
int *  numBoundingBoxes,
double **  boundingBoxes 
)

Returns number of boundingBoxes and boundingBox information for given Dataset.

Parameters:
dataset  (I) tag of Dataset
numBoundingBoxes  (O) Number of BoundingBoxes
boundingBoxes  (OF) 6*numBoundingBoxes Array of BoundingBox information

AE_API int AE_import_named_ref ( tag_t  dataset_tag,
const char *  reference_name,
const char *  os_full_path_name,
const char *  new_file_name,
int  file_type_flag 
)

Imports the specified file, os_full_path_name, into Teamcenter, creating a new ImanFile using the name specified by new_file_name and associates that ImanFile object with the specified dataset object. dataset_tag is the tag of the dataset for which a named reference is added to. reference_name is the name of the reference used for associating new_file_name and the dataset (dataset_tag). os_full_path_name is the full source file name in the operating system. new_file_name is the file name to be used for creating a new file in the volume. new_file_name includes the file extension along with the file name. when new_file_name is an empty string the file name is autogenerated with the extension based on the file_type_flag. file_type_flag is used to specify the file type. Valid values are SS_TEXT and SS_BINARY. Specify SS_TEXT for text file and SS_BINARY for binary file. If file_type_flag is SS_TEXT the file is created with .txt extension. If file_type_flag is SS_BINARY the file is created with .bin extension.

The function returns:

Parameters:
dataset_tag  (I) Tag of the target dataset on or through which the operation is being performed.
reference_name  (I) Name of the reference used for associating the file and dataset.
os_full_path_name  (I) Source location in the operating system (including file name).
new_file_name  (I) Name of the file to be used as meta data in Teamcenter Engineering. (or NULL to have TC allocate a name)
file_type_flag  (I) Flag to indicate BINARY or TEXT file type (use SS_TEXT for text file, and SS_BINARY for binary file)

AE_API int AE_initialize_dataset ( tag_t  dataset,
tag_t  dataset_type,
const char  dataset_name[WSO_name_size_c+1],
const char  dataset_description[WSO_desc_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from TC2009. Use AE_initialize_dataset_with_id instead
Parameters:
dataset  (I)
dataset_type  (I)
dataset_name  (I)
dataset_description  (I)

AE_API int AE_initialize_dataset_with_id ( tag_t  aDataset,
tag_t  dsTypeTag,
const char *  dsName,
const char *  dsDesc,
const char *  dsId,
const char *  dsRev 
)

This function initializes the newly created dataset by the type, name, description, id, and rev specified.

Parameters:
aDataset  (I) The specified Dataset tag that is initialized.
dsTypeTag  (I) The specified Dataset type tag that is used to create the dataset.
dsName  (I) The new user-defined Dataset name.
dsDesc  (I) The new user-defined Dataset description.
dsId  (I) The Dataset id that is used.
dsRev  (I) The Dataset rev that is used.

AE_API int AE_insert_dataset_named_ref ( tag_t  dataset,
int  index,
const char  reference_name[AE_reference_size_c+1],
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_insert_dataset_named_ref2
This function is used to insert a new named reference at the specified position (index) for a dataset. The index starts at 0.
Parameters:
dataset  (I)
index  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_insert_dataset_named_ref2 ( tag_t  dataset,
int  index,
const char *  reference_name,
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

This function is used to insert a new named reference at the specified position (index) for a dataset. The index starts at 0.

Parameters:
dataset  (I)
index  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_is_dataset_unique ( const char  dataset_name[WSO_name_size_c+1],
logical *  result 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_is_dataset_unique2
This function will determine if the dataset name (dsName) is unique in the database. For purposes of this discussion unique means that two or more datasets cannot have the name dsName and that different versions of the same dataset are not considered to be different datasets
  • they are merely back up versions of the same dataset.
Parameters:
dataset_name  (I) Dataset name being used for searching the database.
result  (O) Value "True" if uniqueness is confirmed. "False", otherwise.

AE_API int AE_is_dataset_unique2 ( const char *  dataset_name,
logical *  result 
)

This function will determine if the dataset name (dsName) is unique in the database. For purposes of this discussion unique means that two or more datasets cannot have the name dsName and that different versions of the same dataset are not considered to be different datasets

  • they are merely back up versions of the same dataset.
Parameters:
dataset_name  (I) Dataset name being used for searching the database.
result  (O) Value "True" if uniqueness is confirmed. "False", otherwise.

AE_API int AE_purge_dataset_revs ( tag_t  dataset  ) 

Deletes all unreferenced dataset revisions except the latest revision.

Parameters:
dataset  (I)

AE_API int AE_remove_dataset_named_ref ( tag_t  dataset,
const char  reference_name[AE_reference_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_remove_dataset_named_ref2
Parameters:
dataset  (I)
reference_name  (I)

AE_API int AE_remove_dataset_named_ref2 ( tag_t  dataset,
const char *  reference_name 
)

Parameters:
dataset  (I)
reference_name  (I)

AE_API int AE_remove_dataset_named_ref_by_tag ( tag_t  dataset,
const char  reference_name[AE_reference_size_c+1],
tag_t  referenced_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_remove_dataset_named_ref_by_tag2
Removes named references from datasets.
Parameters:
dataset  (I)
reference_name  (I)
referenced_object  (I)

AE_API int AE_remove_dataset_named_ref_by_tag2 ( tag_t  dataset,
const char *  reference_name,
tag_t  referenced_object 
)

Removes named references from datasets.

Parameters:
dataset  (I)
reference_name  (I)
referenced_object  (I)

AE_API int AE_replace_dataset_named_ref ( tag_t  dataset,
tag_t  old_referenced_object,
const char  reference_name[AE_reference_size_c+1],
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_replace_dataset_named_ref2
This function is used to replace an existing named reference with a new named reference for a dataset.
Parameters:
dataset  (I)
old_referenced_object  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_replace_dataset_named_ref2 ( tag_t  dataset,
tag_t  old_referenced_object,
const char *  reference_name,
AE_reference_type_t  reference_type,
tag_t  previously_saved_object 
)

This function is used to replace an existing named reference with a new named reference for a dataset.

Parameters:
dataset  (I)
old_referenced_object  (I)
reference_name  (I)
reference_type  (I)
previously_saved_object  (I)

AE_API int AE_save_myself ( tag_t  dataset  ) 

Saves any changes made to the dataset mydataset directly to itself. This function differs from AOM_save which saves your changes into a new dataset version. AE_save_myself saves your changes directly into the mydataset dataset version without creating any new dataset version. We recommend you use AE_save_myself whenever you make changes to the attributes or owner/group of a dataset.

Parameters:
dataset  (I)

AE_API int AE_set_absOcc_bounding_boxes ( tag_t  absOccData,
tag_t  dataset,
tag_t  file,
int  numBoundingBoxes,
const double *  boundingBoxes 
)

Sets boundingBox information for given AbsOccData, Dataset and ImanFile.

Parameters:
absOccData  (I) tag of absOccData
dataset  (I) tag of dataset which defines boundingbox
file  (I) tag of imanFile
numBoundingBoxes  (I) Number of BoundingBoxes
boundingBoxes  (I) 6*numBoundingboxes Array of BoundingBox information

AE_API int AE_set_bounding_boxes ( tag_t  dataset,
tag_t  file,
int  numBoundingBoxes,
const double *  boundingBoxes 
)

Parameters:
dataset  (I) tag of dataset which defines boundingbox
file  (I) tag of imanFile
numBoundingBoxes  (I) Number of BoundingBoxes
boundingBoxes  (I) 6*numBoundingboxes Array of BoundingBox information

AE_API int AE_set_dataset_datasettype ( tag_t  dataset,
tag_t  datasettype 
)

Sets the datasettype attribute for the input dataset.

Parameters:
dataset  (I)
datasettype  (I)

AE_API int AE_set_dataset_format ( tag_t  dataset,
const char  format_name[AE_io_format_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_set_dataset_format2
Sets the format attribute for the input dataset.

These functions ask or set a dataset named reference operating system file format. Allowed file formats are:

TEXT_REF - ASCII text files
BINARY_REF - Binary files.

Parameters:
dataset  (I)
format_name  (I)

AE_API int AE_set_dataset_format2 ( tag_t  dataset,
const char *  format_name 
)

Sets the format attribute for the input dataset.

These functions ask or set a dataset named reference operating system file format. Allowed file formats are:

TEXT_REF - ASCII text files
BINARY_REF - Binary files.

Parameters:
dataset  (I)
format_name  (I)

AE_API int AE_set_dataset_id_rev ( tag_t  aDataset,
const char *  aDatasetId,
const char *  aDatasetRev 
)

This function sets the id and rev for a specified Dataset.

Parameters:
aDataset  (I) The Dataset tag that is used to set its id and rev.
aDatasetId  (I) The Dataset id that is used.
aDatasetRev  (I) The Dataset rev that is used.

AE_API int AE_set_dataset_siteclass ( tag_t  dataset,
const char  site_classification[AE_siteclass_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_set_dataset_siteclass2
Sets the site classification attribute for the input dataset.
Parameters:
dataset  (I)
site_classification  (I)

AE_API int AE_set_dataset_siteclass2 ( tag_t  dataset,
const char *  site_classification 
)

Sets the site classification attribute for the input dataset.

Parameters:
dataset  (I)
site_classification  (I)

AE_API int AE_set_dataset_tool ( tag_t  dataset,
tag_t  tool 
)

Sets the tool attribute for the input dataset.

Parameters:
dataset  (I)
tool  (I)