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

DatasetType
[Application Encapsulation]

Tool

Defines

Functions

Define Documentation

#define AE_EXPORT   1

Definition at line 32 of file datasettype.h.

#define AE_NOEXPORT   0

Definition at line 31 of file datasettype.h.

#define BINARY_REF   "BINARY"

Definition at line 28 of file datasettype.h.

#define EXPORT   AE_EXPORT

Deprecated:
EXPORT and NOEXPORT are deprecated and will be removed from Teamcenter Engineering v13.0. In their place, please use AE_EXPORT and AE_NOEXPORT repectively.

Definition at line 57 of file datasettype.h.

#define NOEXPORT   AE_NOEXPORT

Definition at line 62 of file datasettype.h.

#define OBJECT_REF   "OBJECT"

Definition at line 29 of file datasettype.h.

#define TEXT_REF   "TEXT"

Definition at line 27 of file datasettype.h.

Function Documentation

AE_API int AE_ask_datasettype_action ( tag_t  datasettype,
AE_action_t  action,
int *  on_or_off 
)

Return nonzero (TRUE) if the input action is registered. Return 0 if it is not.

Parameters:
datasettype  (I)
action  (I)
on_or_off  (O)

AE_API int AE_ask_datasettype_children ( tag_t  datasettype,
int *  child_count,
tag_t **  child_tags 
)

Sets and returns the parent datasettype or the children datasettypes for the input datasettype. Parents are not required, but they give the ability for a site to classify their data types.

Parameters:
datasettype  (I)
child_count  (O)
child_tags  (OF) child_count

AE_API int AE_ask_datasettype_def_tool ( tag_t  datasettype,
tag_t *  tool 
)

Manipulates the set of tools that can be used with a particular datasettype. The "default" tool is the first tool in the list. If you remove the first tool in the list, the second tool then becomes the default tool.

Parameters:
datasettype  (I)
tool  (O)

AE_API int AE_ask_datasettype_def_view_tool ( tag_t  datasettype,
tag_t *  tool 
)

Manipulates the set of tools that can be used with a particular datasettype. The "default" tool is the first tool in the list. If you remove the first tool in the list, the second tool then becomes the default tool.

Parameters:
datasettype  (I)
tool  (O)

AE_API int AE_ask_datasettype_desc ( tag_t  datasettype,
char  datasettype_desc[AE_datasettype_desc_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_datasettype_desc2
Gets description for datasettypes, since they are not WorkspaceObjects.
Parameters:
datasettype  (I)
datasettype_desc  (O)

AE_API int AE_ask_datasettype_desc2 ( tag_t  datasettype,
char **  datasettype_desc 
)

Gets description for datasettypes, since they are not WorkspaceObjects.

Parameters:
datasettype  (I)
datasettype_desc  (OF)

AE_API int AE_ask_datasettype_file_refs ( tag_t  datasettype,
const char *  ref_name,
int *  count,
char ***  ref_templates,
char ***  ref_formats 
)

Returns the list of references of name ref_name for the specified datasettype. If more than one reference of the same name exist, then count gives the total number of such references of that name.

Parameters:
datasettype  (I) Tag of the datasettype for which the ref_templates and ref_formats are required.
ref_name  (I) Name of the reference.
count  (O) Number of references of the name ref_name for the datasettype.
ref_templates  (OF) count List of template specifications for the reference name ref_name.
ref_formats  (OF) count List of format specifications for the reference name ref_name.

AE_API int AE_ask_datasettype_name ( tag_t  datasettype,
char  datasettype_name[AE_datasettype_name_size_c+1] 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_datasettype_name2
Gets the name for datasettypes, since they are not WorkspaceObjects.
Parameters:
datasettype  (I)
datasettype_name  (O)

AE_API int AE_ask_datasettype_name2 ( tag_t  datasettype,
char **  datasettype_name 
)

Gets the name for datasettypes, since they are not WorkspaceObjects.

Parameters:
datasettype  (I)
datasettype_name  (OF)

AE_API int AE_ask_datasettype_parent ( tag_t  datasettype,
tag_t *  parent_type 
)

Sets and returns the parent datasettype or the children datasettypes for the input datasettype. Parents are not required, but they give the ability for a site to classify their data types.

Parameters:
datasettype  (I)
parent_type  (O)

AE_API int AE_ask_datasettype_refs ( tag_t  datasettype,
int *  ref_count,
char ***  ref_list 
)

Returns the list of strings which are the names of named references that datasets of this type can have. Free up the space used by ref_list with MEM_free .

    {
        int istat = ITK_ok;
        char** ref_list;
        int ref_count;
        tag_t datasettype;
        int i;

        ... Get datasettype from somewhere ...

        istat = AE_ask_datasettype_refs (datasettype, &ref_count, &ref_list);
        if( istat == ITK_ok )
        {
            for (i = 0; i < ref_count; i++)
            {
                printf ("named reference %d is <%s>./n", i + 1, ref_list[i]);
            }
            MEM_free (ref_list);
        }
        else
        {
            printf ("Error %d asking for datasettype references./n", istat);
        }

        ...

    }
Parameters:
datasettype  (I)
ref_count  (O) The number of strings returned.
ref_list  (OF) ref_count The list of strings.

AE_API int AE_ask_datasettype_tools ( tag_t  datasettype,
int *  tool_count,
tag_t **  tool_list 
)

Manipulates the set of tools that can be used with a particular datasettype. The "default" tool is the first tool in the list. If you remove the first tool in the list, the second tool then becomes the default tool.

Use MEM_free to free up the memory allocated for tool_list by AE_ask_datasettype_tools .

Parameters:
datasettype  (I)
tool_count  (O)
tool_list  (OF) tool_count

AE_API int AE_ask_datasettype_view_tools ( tag_t  datasettype,
int *  tool_count,
tag_t **  tool_list 
)

Manipulates the set of tools that can be used with a particular datasettype. The "default" tool is the first tool in the list. If you remove the first tool in the list, the second tool then becomes the default tool.

Use MEM_free to free up the memory allocated for tool_list by AE_ask_datasettype_view_tools .

Parameters:
datasettype  (I)
tool_count  (O)
tool_list  (OF) tool_count

AE_API int AE_ask_oper_postaction ( tag_t  dtag,
tag_t  tool,
int  oper_name,
tag_t *  postaction_tool 
)

Parameters:
dtag  (I)
tool  (I)
oper_name  (I)
postaction_tool  (O)

AE_API int AE_ask_oper_postaction_params ( tag_t  dtag,
tag_t  tool,
int  oper_name,
int *  no_params,
char ***  param_names 
)

Parameters:
dtag  (I)
tool  (I)
oper_name  (I)
no_params  (O)
param_names  (OF) no_params

AE_API int AE_ask_oper_preaction ( tag_t  dtag,
tag_t  tool,
int  oper_name,
tag_t *  preaction_tool 
)

Parameters:
dtag  (I)
tool  (I)
oper_name  (I)
preaction_tool  (O)

AE_API int AE_ask_oper_preaction_params ( tag_t  dtag,
tag_t  tool,
int  oper_name,
int *  no_params,
char ***  param_names 
)

Parameters:
dtag  (I)
tool  (I)
oper_name  (I)
no_params  (O)
param_names  (OF) no_params

AE_API int AE_ask_tool_oper_params ( tag_t  dtag,
tag_t  tool,
int  oper_name,
int *  no_params,
char ***  param_names 
)

Returns the parameters for the datasettype, tool and operation oper_name combination.

Parameters:
dtag  (I) Tag of the datasettype.
tool  (I) Tag of the tool.
oper_name  (I) Identifier of the operation (e.g., ACTION_open , ACTION_print , etc.).
no_params  (O) Number of parameters for the datasettype, tool and operation combination.
param_names  (OF) no_params List of parameters for the specified datasettype, tool and operation combination.

AE_API int AE_ask_tool_oper_refs ( tag_t  dtag,
tag_t  tool,
int  oper_name,
int *  no_refs,
char ***  ref_names,
int **  export_flags 
)

Returns the references for the tool and datasettype combination for the operation oper_name.

Parameters:
dtag  (I) Tag of the datasettype.
tool  (I) Tag of the tool.
oper_name  (I) Identifier of the operation (e.g., ACTION_open, ACTION_print, etc.).
no_refs  (O) Number of references for the specified datasettype, tool and operation combination.
ref_names  (OF) no_refs List of references for the specified datasettype, tool and operation combination.
export_flags  (OF) no_refs List of export flags for the above list of ref_names with the value of 1 or 0, where 1 is ON and 0 is OFF.

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

Returns the tags of all of the datasettypes in the database.

Parameters:
n_instances  (O)
instances  (OF) n_instances

AE_API int AE_find_datasettype ( const char  datasettype_name[AE_datasettype_name_size_c+1],
tag_t *  datasettype 
)

Deprecated:
This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_find_datasettype2
Finds a datasettype with the input name. An error code not equal to ITK_ok means that some error occurred while searching for the datasettype with the name specified. A return of ITK_ok means that there was no error. It does not mean that a datasettype was found. The value of datasettype must be compared with NULLTAG to determine if a datasettype was actually found.

    {
        int stat;
        tag_t a_datasettype;
        char dst_name[AE_datasettype_name_size_c + 1];
        strcpy (dst_name, "some_datasettype_to_find");
        stat = AE_find_datasettype (dst_name, &a_datasettype);
        if( stat != ITK_ok )
        {
            printf ("Error %d finding datasettype %s./n", stat, dst_name);
        }
        else
        {
            if (a_datasettype == NULLTAG)
            {
                printf ("DatasetType %s does not exist./n", dst_name);
            }
        }
    }
Parameters:
datasettype_name  (I)
datasettype  (O)

AE_API int AE_find_datasettype2 ( const char *  datasettype_name,
tag_t *  datasettype 
)

Finds a datasettype with the input name. An error code not equal to ITK_ok means that some error occurred while searching for the datasettype with the name specified. A return of ITK_ok means that there was no error. It does not mean that a datasettype was found. The value of datasettype must be compared with NULLTAG to determine if a datasettype was actually found.

    {
        int stat;
        tag_t a_datasettype;
        char dst_name[AE_datasettype_name_size_c + 1];
        strcpy (dst_name, "some_datasettype_to_find");
        stat = AE_find_datasettype (dst_name, &a_datasettype);
        if( stat != ITK_ok )
        {
            printf ("Error %d finding datasettype %s./n", stat, dst_name);
        }
        else
        {
            if (a_datasettype == NULLTAG)
            {
                printf ("DatasetType %s does not exist./n", dst_name);
            }
        }
    }
Parameters:
datasettype_name  (I)
datasettype  (O)

AE_API int AE_init_datasettype_actions ( tag_t  datasettype,
int  on_or_off 
)

Initialize all of the actions to either on or off depending on the value of on_or_off.

Parameters:
datasettype  (I)
on_or_off  (I)