Fnd0nweditor.h File Reference

#include <Fnd0nweditor/libfnd0nweditor_exports.h>
#include <Fnd0nweditor/libfnd0nweditor_undef.h>

Go to the source code of this file.

Functions
FND0NWEDITOR_API int	FND0NWEDITOR_create_diagram (tag_t selectedObj, int numNames, char **names, int numValues, char **values, logical openDiagram, char **appDomain, int *numTmplFilePaths, char ***diagramTmplFilePaths, char **diagMappingFilePath, tag_t *diagramRev, int *numDiagramMem, tag_t **diagramMembersPrimary, tag_t **diagramMembersPersistent, char ***typeNames, int *numRelationMembers, tag_t **relationMembers)
FND0NWEDITOR_API int	FND0NWEDITOR_create_or_update_template (tag_t revTag, int numNames, char **names, int numValues, char **values, logical isAvailable, int numStencilFilePaths, char **tmplStencilFilePaths, char *tmplMappingFilePath, tag_t membershipRule, int numRelationRule, char **relationRule, logical hidePorts, tag_t *diagramTmplRev)
FND0NWEDITOR_API int	FND0NWEDITOR_open_diagram (tag_t selectedObj, tag_t diagram_revision, int *n_template_tickets, char ***fms_template_tickets, char **diagMappingFileTicket, char **diagramFileTicketStr, char **appDomain, tag_t *startObjectTag, int *numObjectUIDs, char ***objectUIDsStr, int **shapeIDsInt, int *numDiagramMem, tag_t **DiagramMembersTagsPrimary, tag_t **DiagramMembersTagsPersistent, char ***typeNamesStr, tag_t **shapeRelationsOnMembers, int *numRelationMembers, tag_t **RelationMembersTags, tag_t **shapeRelationsOnRelationsTags)
FND0NWEDITOR_API int	FND0NWEDITOR_save_diagram (tag_t selectedObj, tag_t diagramRevisionTag, char *fms_diagramTicket, char *fms_diagramImageTicket, int *numResultObjs, tag_t **resultObjs)

Detailed Description

This file contains ITK function declarations for Fnd0nweditor.

Definition in file Fnd0nweditor.h.

Function Documentation

FND0NWEDITOR_API int FND0NWEDITOR_create_diagram	(	tag_t	selectedObj,
		int	numNames,
		char **	names,
		int	numValues,
		char **	values,
		logical	openDiagram,
		char **	appDomain,
		int *	numTmplFilePaths,
		char ***	diagramTmplFilePaths,
		char **	diagMappingFilePath,
		tag_t *	diagramRev,
		int *	numDiagramMem,
		tag_t **	diagramMembersPrimary,
		tag_t **	diagramMembersPersistent,
		char ***	typeNames,
		int *	numRelationMembers,
		tag_t **	relationMembers
	)

This function creates a Diagram object for the selected object. The objects shown on the diagram follow the relationship rules and membership rules selected on the diagram template.

Parameters

selectedObj	(I) Selected/Starting/Root object of the diagram (BusinessObjectRef<Teamcenter::BusinessObject>)
numNames	(I) Number of property names
names	(I) Property Names
numValues	(I) Number of property values
values	(I) Property Values
openDiagram	(I) Whether to open diagram or not
appDomain	(O) Application domain of this diagram
numTmplFilePaths	(O) Number of template files
diagramTmplFilePaths	(O) numTmplFilePaths File paths of the stencil and template files
diagMappingFilePath	(O) File path of the Diagram mapping file
diagramRev	(O) Rev tag for new diagram created
numDiagramMem	(O) count of memebers
diagramMembersPrimary	(O) numDiagramMem List of diagram members
diagramMembersPersistent	(O) numDiagramMem List of persistent objects of the diagram members
typeNames	(O) numDiagramMem List of type names of diagram members
numRelationMembers	(O) count of relations
relationMembers	(O) numRelationMembers List of relation objects between diagram members

FND0NWEDITOR_API int FND0NWEDITOR_create_or_update_template	(	tag_t	revTag,
		int	numNames,
		char **	names,
		int	numValues,
		char **	values,
		logical	isAvailable,
		int	numStencilFilePaths,
		char **	tmplStencilFilePaths,
		char *	tmplMappingFilePath,
		tag_t	membershipRule,
		int	numRelationRule,
		char **	relationRule,
		logical	hidePorts,
		tag_t *	diagramTmplRev
	)

This function creates or updates a diagram template.

Parameters

revTag	(I) Revision Tag
numNames	(I) count of property names
names	(I) Names of properties
numValues	(I) Count of property values
values	(I) Values for properties
isAvailable	(I) Is this template available
numStencilFilePaths	(I) Number of stencil files to import
tmplStencilFilePaths	(I) Collection of FMS tickets to diagramming tool specific stencil/template files
tmplMappingFilePath	(I) FMS ticket to property map xml file
membershipRule	(I) Membership Rule
numRelationRule	(I) Number of Relations in the Relationship Rule
relationRule	(I) Relationship Rules
hidePorts	(I) Flag to indicate whether ports have to be shown for diagrams using this template
diagramTmplRev	(O) Diagram Template Revision Object

FND0NWEDITOR_API int FND0NWEDITOR_open_diagram	(	tag_t	selectedObj,
		tag_t	diagram_revision,
		int *	n_template_tickets,
		char ***	fms_template_tickets,
		char **	diagMappingFileTicket,
		char **	diagramFileTicketStr,
		char **	appDomain,
		tag_t *	startObjectTag,
		int *	numObjectUIDs,
		char ***	objectUIDsStr,
		int **	shapeIDsInt,
		int *	numDiagramMem,
		tag_t **	DiagramMembersTagsPrimary,
		tag_t **	DiagramMembersTagsPersistent,
		char ***	typeNamesStr,
		tag_t **	shapeRelationsOnMembers,
		int *	numRelationMembers,
		tag_t **	RelationMembersTags,
		tag_t **	shapeRelationsOnRelationsTags
	)

This function opens a Diagram created for the selected object.

Parameters

selectedObj	(I) Selected/Starting/Root object of the diagram (BusinessObjectRef<Teamcenter::BusinessObject>)
diagram_revision	(I) Diagram for the selection
n_template_tickets	(O) The number of diagram templates
fms_template_tickets	(O) n_template_tickets The diagram templates
diagMappingFileTicket	(O) The diagram Mapping file
diagramFileTicketStr	(O) The diagram
appDomain	(O) The Application Domain for the diagram
startObjectTag	(O) Root object for the Diagram
numObjectUIDs	(O) Number of object UIDs
objectUIDsStr	(O) numObjectUIDs Object UIDs
shapeIDsInt	(O) Shape IDs
numDiagramMem	(O) Number of Diagram Members
DiagramMembersTagsPrimary	(O) numDiagramMem Diagram Tags Primary
DiagramMembersTagsPersistent	(O) numDiagramMem Diagram Tags Persistent
typeNamesStr	(O) numDiagramMem Type Names for Diagram Members
shapeRelationsOnMembers	(O) numDiagramMem Shape relations for Diagram Memebers
numRelationMembers	(O) Number of Relation Members
RelationMembersTags	(O) numRelationMembers Relation Member tags
shapeRelationsOnRelationsTags	(O) numRelationMembers Shape Relations on relation tags

FND0NWEDITOR_API int FND0NWEDITOR_save_diagram	(	tag_t	selectedObj,
		tag_t	diagramRevisionTag,
		char *	fms_diagramTicket,
		char *	fms_diagramImageTicket,
		int *	numResultObjs,
		tag_t **	resultObjs
	)

This function saves a Diagram dataset.

Parameters

selectedObj	(I) Selected/Starting/Root object of the diagram (BusinessObjectRef<Teamcenter::BusinessObject>)
diagramRevisionTag	(I) Diagram Revision tag (NULLTAG is NOT allowed)
fms_diagramTicket	(I) FMS ticket to the diagram file
fms_diagramImageTicket	(I) FMS ticket to the diagram Image file(JPEG or PNG)
numResultObjs	(O) Number of result objects
resultObjs	(O) numResultObjs Result objects