Visualization

Data Structures
struct	VIS_additional_keyvalue_s
struct	VIS_basedoc_output_s
struct	VIS_object_input_s

Macros
#define	USER_VIS_get_basedocument_msg   "BMF_USER_VIS_get_basedocument"
#define	USER_VIS_get_metadata_filename_context_msg   "BMF_USER_VIS_get_metadata_filename_context"
#define	USER_VIS_get_metadata_filename_msg   "BMF_USER_VIS_get_metadata_filename"

Typedefs
typedef struct VIS_additional_keyvalue_s *	VIS_additional_keyvalue_p_t
typedef struct VIS_additional_keyvalue_s	VIS_additional_keyvalue_t
typedef struct VIS_basedoc_output_s *	VIS_basedoc_output_p_t
typedef struct VIS_basedoc_output_s	VIS_basedoc_output_t
typedef struct VIS_object_input_s *	VIS_object_input_p_t
typedef struct VIS_object_input_s	VIS_object_input_t

Functions
VIS_API int	USER_VIS_get_metadata_filename (tag_t object, char **mds_file_path)
VIS_API int	USER_VIS_get_metadata_filename_context (tag_t object, tag_t context, char **mds_file_path)

Variables
VIS_additional_keyvalue_p_t	VIS_object_input_s::additional_info
VIS_additional_keyvalue_p_t	VIS_basedoc_output_s::additional_info
tag_t	VIS_basedoc_output_s::base_doc
tag_t	VIS_basedoc_output_s::base_doc_item
tag_t	VIS_basedoc_output_s::base_doc_itemrev
tag_t *	VIS_object_input_s::context_tags
char *	VIS_additional_keyvalue_s::key
int	VIS_object_input_s::n_context_tags
int	VIS_object_input_s::n_key_value
int	VIS_basedoc_output_s::n_key_value
tag_t	VIS_object_input_s::object
char *	VIS_additional_keyvalue_s::value

Detailed Description

This module implements the ITK methods exposed by the Visualization module.

Macro Definition Documentation

#define USER_VIS_get_basedocument_msg   "BMF_USER_VIS_get_basedocument"

Provides new user exit to generate the base document for an object to be visualized.

Definition at line 45 of file vis_user_exit.h.

#define USER_VIS_get_metadata_filename_context_msg   "BMF_USER_VIS_get_metadata_filename_context"

Provides new user exit to generate the MetaDataStamp filename for an object with context.

Definition at line 40 of file vis_user_exit.h.

#define USER_VIS_get_metadata_filename_msg   "BMF_USER_VIS_get_metadata_filename"

Provides new user exit to generate the MetadataStamp filename for an object.

Definition at line 35 of file vis_user_exit.h.

Typedef Documentation

typedef struct VIS_additional_keyvalue_s* VIS_additional_keyvalue_p_t

typedef struct VIS_additional_keyvalue_s VIS_additional_keyvalue_t

Generic structure for holding key/value pairs.

typedef struct VIS_basedoc_output_s * VIS_basedoc_output_p_t

typedef struct VIS_basedoc_output_s VIS_basedoc_output_t

The base document of the Teamcenter object will be loaded by Teamcenter Visualization.
For example, if an Item is visualized, it is resolved to either BomView Revision, Dataset or VisStructureContext.

typedef struct VIS_object_input_s * VIS_object_input_p_t

typedef struct VIS_object_input_s VIS_object_input_t

Teamcenter object and its related information needed in order for the objects to be visualized.
For example, to visualize Dataset, context information like its Item, ItemRevision may possibly be needed.

Function Documentation

VIS_API int USER_VIS_get_metadata_filename	(	tag_t	object,
		char **	mds_file_path
	)

Generates Metadata Stamp (MDS) file for the given object and returns the absolute path of the MDS file.

Returns

• ITK_ok on success
• TYPE_invalid_type_name if the object type is invalid

Parameters

object	(I) Tag of object.
mds_file_path	(OF) Absolute path of the MDS file.

VIS_API int USER_VIS_get_metadata_filename_context	(	tag_t	object,
		tag_t	context,
		char **	mds_file_path
	)

Generates Metadata Stamp (MDS) file for the given object of type or sub-type of POM_object and its Context object.

Returns

• ITK_ok on success.
• CXPOM_invalid_tag if object is NULLTAG or invalid.
• POM_invalid_tag if object is not a type or subtype of POM_object.
• Possibly other errors.

Parameters

object	(I) The object.
context	(I) Its Context object. It can be NULLTAG.
mds_file_path	(OF) Absolute path of the MDS file.

Variable Documentation

VIS_additional_keyvalue_p_t VIS_object_input_s::additional_info

Array of length n_key_value that contains the additional key/value pairs.

Definition at line 67 of file vis_user_exit.h.

VIS_additional_keyvalue_p_t VIS_basedoc_output_s::additional_info

Array of length n_key_value that contains the additional key/value pairs.

Definition at line 80 of file vis_user_exit.h.

tag_t VIS_basedoc_output_s::base_doc

The base document object.

Definition at line 76 of file vis_user_exit.h.

tag_t VIS_basedoc_output_s::base_doc_item

The Item of the base document (if any).

Definition at line 77 of file vis_user_exit.h.

tag_t VIS_basedoc_output_s::base_doc_itemrev

The Item Revision of the base document (if any).

Definition at line 78 of file vis_user_exit.h.

tag_t* VIS_object_input_s::context_tags

Its list of context objects. It can be NULLTAG(s).

Definition at line 65 of file vis_user_exit.h.

char* VIS_additional_keyvalue_s::key

Name of the key.

Definition at line 53 of file vis_user_exit.h.

int VIS_object_input_s::n_context_tags

The number of context objects.

Definition at line 64 of file vis_user_exit.h.

int VIS_object_input_s::n_key_value

The number of additional key/value pairs.

Definition at line 66 of file vis_user_exit.h.

int VIS_basedoc_output_s::n_key_value

The number of additional key/value pairs.

Definition at line 79 of file vis_user_exit.h.

tag_t VIS_object_input_s::object

The object on which base document is retrieved.

Definition at line 63 of file vis_user_exit.h.

char* VIS_additional_keyvalue_s::value

Its value.

Definition at line 54 of file vis_user_exit.h.