This builder is used to publish Technical Data Package, or TDP for short. More...

Inheritance diagram for NXOpen::TDP::PublisherBuilder:

Public Types
enum	ModelAccuracyType { ModelAccuracyTypeMaximum, ModelAccuracyTypeHigh, ModelAccuracyTypeMedium, ModelAccuracyTypeLow }
	This enum indicates the level of accuracy for publishing a 3D PDF TDP. More...

enum	PublishResult { PublishResultSuccess, PublishResultSuccessWithInconsistency, PublishResultSuccessWithError, PublishResultFail }
	This enum indicates the results of publishing the TDP. More...

enum	ViewSelectionType { ViewSelectionTypeSelectedViews, ViewSelectionTypeAllDisclosedViews, ViewSelectionTypeAllUserDefinedViews }
	This enum indicates how the views are selected for publishing TDP. More...

Public Member Functions
void	AddAttachment (const NXString &filename)
	This method adds the new attachment filename to the end of the attachment list. More...

void	AddAttachment (const char *filename)
	This method adds the new attachment filename to the end of the attachment list. More...

bool	Compression ()
	Returns the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template. More...

void	DeleteAttachmentAtIndices (const std::vector< int > &indices)
	This method deletes the attachment filenames at the indicated indices and re-populate the attachment filename list with new continuous indices. More...

void	GetAttachments (std::vector< NXString > &attachments)
	This method returns the list of attachment filenames Created in NX1847.0.0. More...

void	GetTextLabels (std::vector< NXString > &labels)
	This method returns the list of text labels. More...

bool	GetTextValueOfLabel (const NXString &label, NXString *value)
	This method returns the value of the text with the given label, if the text exists. More...

bool	GetTextValueOfLabel (const char label, NXString value)
	This method returns the value of the text with the given label, if the text exists. More...

NXString	GetWorkTemplateFilename ()
	This method returns the name of the template file that is being worked on. More...

bool	HasTextOfLabel (const NXString &label)
	This method checks to see if a text with the given label exists for the selected template. More...

bool	HasTextOfLabel (const char *label)
	This method checks to see if a text with the given label exists for the selected template. More...

NXOpen::TDP::PublisherBuilder::ModelAccuracyType	ModelAccuracy ()
	Returns the 3D PDF model accuracy, if the template to be published is a 3D PDF template. More...

NXString	OutputFilename ()
	Returns the output filename for the TDP Created in NX1847.0.0. More...

NXOpen::TDP::PublisherBuilder::PublishResult	Publish ()
	This method publishes the TDP with builder's data. More...

NXOpen::SelectViewList *	SelectedViews ()
	Returns the selected views to publish TDP for, if the view selection method is set to NXOpen::TDP::PublisherBuilder::ViewSelectionTypeSelectedViews. More...

void	SetCompression (bool compression)
	Sets the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template. More...

void	SetModelAccuracy (NXOpen::TDP::PublisherBuilder::ModelAccuracyType modelAccuracy)
	Sets the 3D PDF model accuracy, if the template to be published is a 3D PDF template. More...

void	SetOutputFilename (const NXString &filename)
	Sets the output filename for the TDP Created in NX1847.0.0. More...

void	SetOutputFilename (const char *filename)
	Sets the output filename for the TDP Created in NX1847.0.0. More...

void	SetPassword (const NXString &password)
	This method sets the password. More...

void	SetPassword (const char *password)
	This method sets the password. More...

bool	SetTextValueOfLabel (const NXString &label, const NXString &value)
	This method sets the value of the text with the given label, if the text exists. More...

bool	SetTextValueOfLabel (const char label, const char value)
	This method sets the value of the text with the given label, if the text exists. More...

void	SetUsePassword (bool usePassword)
	Sets the flag whether to use password or not Created in NX1847.0.0. More...

void	SetViewSelection (NXOpen::TDP::PublisherBuilder::ViewSelectionType viewSelection)
	Sets the view selection method Created in NX1847.0.0. More...

void	SetWorkTemplateFile (const NXString &templateFilename)
	This method sets the template to publish TDP and repopulates the text table. More...

void	SetWorkTemplateFile (const char *templateFilename)
	This method sets the template to publish TDP and repopulates the text table. More...

bool	UsePassword ()
	Returns the flag whether to use password or not Created in NX1847.0.0. More...

NXOpen::TDP::PublisherBuilder::ViewSelectionType	ViewSelection ()
	Returns the view selection method Created in NX1847.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

This builder is used to publish Technical Data Package, or TDP for short.

It collects all the necessary inputs from a TDP template and other user options before publishing TDP.
To create a new instance of this class, use NXOpen::TDP::Manager::CreateTdpPublisherBuilder

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::TDP::PublisherBuilder::ModelAccuracyType

This enum indicates the level of accuracy for publishing a 3D PDF TDP.

Enumerator
ModelAccuracyTypeMaximum	maximum
ModelAccuracyTypeHigh	high
ModelAccuracyTypeMedium	medium
ModelAccuracyTypeLow	low

enum NXOpen::TDP::PublisherBuilder::PublishResult

This enum indicates the results of publishing the TDP.

Enumerator
PublishResultSuccess	success
PublishResultSuccessWithInconsistency	success with inconsistency
PublishResultSuccessWithError	success with error
PublishResultFail	fail

enum NXOpen::TDP::PublisherBuilder::ViewSelectionType

This enum indicates how the views are selected for publishing TDP.

Enumerator
ViewSelectionTypeSelectedViews	selected views
ViewSelectionTypeAllDisclosedViews	all disclosed views
ViewSelectionTypeAllUserDefinedViews	all user defined views

Member Function Documentation

void NXOpen::TDP::PublisherBuilder::AddAttachment ( const NXString & filename )

This method adds the new attachment filename to the end of the attachment list.

Created in NX1847.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::TDP::PublisherBuilder::AddAttachment ( const char * filename )

This method adds the new attachment filename to the end of the attachment list.

Created in NX1847.0.0.

License requirements : None

Parameters

filename filename

bool NXOpen::TDP::PublisherBuilder::Compression ( )

Returns the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template.

Created in NX1847.0.0.

License requirements : None

void NXOpen::TDP::PublisherBuilder::DeleteAttachmentAtIndices ( const std::vector< int > & indices )

This method deletes the attachment filenames at the indicated indices and re-populate the attachment filename list with new continuous indices.

Created in NX1847.0.0.

License requirements : None

Parameters

indices indices

void NXOpen::TDP::PublisherBuilder::GetAttachments ( std::vector< NXString > & attachments )

This method returns the list of attachment filenames
Created in NX1847.0.0.

License requirements : None

Parameters

attachments attachments

void NXOpen::TDP::PublisherBuilder::GetTextLabels ( std::vector< NXString > & labels )

This method returns the list of text labels.

Created in NX1847.0.0.

License requirements : None

Parameters

labels labels

bool NXOpen::TDP::PublisherBuilder::GetTextValueOfLabel	(	const NXString &	label,
		NXString *	value
	)

This method returns the value of the text with the given label, if the text exists.

Created in NX1847.0.0.

License requirements : None

Parameters

label	label
value	value

bool NXOpen::TDP::PublisherBuilder::GetTextValueOfLabel	(	const char *	label,
		NXString *	value
	)

This method returns the value of the text with the given label, if the text exists.

Created in NX1847.0.0.

License requirements : None

Parameters

label	label
value	value

NXString NXOpen::TDP::PublisherBuilder::GetWorkTemplateFilename ( )

This method returns the name of the template file that is being worked on.

Created in NX1847.0.0.

License requirements : None

bool NXOpen::TDP::PublisherBuilder::HasTextOfLabel ( const NXString & label )

This method checks to see if a text with the given label exists for the selected template.

Created in NX1847.0.0.

License requirements : None

Parameters

label label

bool NXOpen::TDP::PublisherBuilder::HasTextOfLabel ( const char * label )

This method checks to see if a text with the given label exists for the selected template.

Created in NX1847.0.0.

License requirements : None

Parameters

label label

NXOpen::TDP::PublisherBuilder::ModelAccuracyType NXOpen::TDP::PublisherBuilder::ModelAccuracy ( )

Returns the 3D PDF model accuracy, if the template to be published is a 3D PDF template.

Created in NX1847.0.0.

License requirements : None

NXString NXOpen::TDP::PublisherBuilder::OutputFilename ( )

Returns the output filename for the TDP
Created in NX1847.0.0.

License requirements : None

NXOpen::TDP::PublisherBuilder::PublishResult NXOpen::TDP::PublisherBuilder::Publish ( )

This method publishes the TDP with builder's data.

Created in NX1847.0.0.

License requirements : nx_tdp (" NX Technical Data Package")

NXOpen::SelectViewList* NXOpen::TDP::PublisherBuilder::SelectedViews ( )

Returns the selected views to publish TDP for, if the view selection method is set to NXOpen::TDP::PublisherBuilder::ViewSelectionTypeSelectedViews.

Created in NX1847.0.0.

License requirements : None

void NXOpen::TDP::PublisherBuilder::SetCompression ( bool compression )

Sets the flag whether to use lossy compression for 3D PDF model, if the template to be published is a 3D PDF template.

Created in NX1847.0.0.

License requirements : None

Parameters

compression compression

void NXOpen::TDP::PublisherBuilder::SetModelAccuracy ( NXOpen::TDP::PublisherBuilder::ModelAccuracyType modelAccuracy )

Sets the 3D PDF model accuracy, if the template to be published is a 3D PDF template.

Created in NX1847.0.0.

License requirements : None

Parameters

modelAccuracy modelaccuracy

void NXOpen::TDP::PublisherBuilder::SetOutputFilename ( const NXString & filename )

Sets the output filename for the TDP
Created in NX1847.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::TDP::PublisherBuilder::SetOutputFilename ( const char * filename )

Sets the output filename for the TDP
Created in NX1847.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::TDP::PublisherBuilder::SetPassword ( const NXString & password )

This method sets the password.

Created in NX1847.0.0.

License requirements : None

Parameters

password password

void NXOpen::TDP::PublisherBuilder::SetPassword ( const char * password )

This method sets the password.

Created in NX1847.0.0.

License requirements : None

Parameters

password password

bool NXOpen::TDP::PublisherBuilder::SetTextValueOfLabel	(	const NXString &	label,
		const NXString &	value
	)

This method sets the value of the text with the given label, if the text exists.

Created in NX1847.0.0.

License requirements : None

Parameters

label	label
value	value

bool NXOpen::TDP::PublisherBuilder::SetTextValueOfLabel	(	const char *	label,
		const char *	value
	)

This method sets the value of the text with the given label, if the text exists.

Created in NX1847.0.0.

License requirements : None

Parameters

label	label
value	value

void NXOpen::TDP::PublisherBuilder::SetUsePassword ( bool usePassword )

Sets the flag whether to use password or not
Created in NX1847.0.0.

License requirements : None

Parameters

usePassword usepassword

void NXOpen::TDP::PublisherBuilder::SetViewSelection ( NXOpen::TDP::PublisherBuilder::ViewSelectionType viewSelection )

Sets the view selection method
Created in NX1847.0.0.

License requirements : None

Parameters

viewSelection viewselection

void NXOpen::TDP::PublisherBuilder::SetWorkTemplateFile ( const NXString & templateFilename )

This method sets the template to publish TDP and repopulates the text table.

Created in NX1847.0.0.

License requirements : None

Parameters

templateFilename templatefilename

void NXOpen::TDP::PublisherBuilder::SetWorkTemplateFile ( const char * templateFilename )

This method sets the template to publish TDP and repopulates the text table.

Created in NX1847.0.0.

License requirements : None

Parameters

templateFilename templatefilename

bool NXOpen::TDP::PublisherBuilder::UsePassword ( )

Returns the flag whether to use password or not
Created in NX1847.0.0.

License requirements : None

NXOpen::TDP::PublisherBuilder::ViewSelectionType NXOpen::TDP::PublisherBuilder::ViewSelection ( )

Returns the view selection method
Created in NX1847.0.0.

License requirements : None

The documentation for this class was generated from the following file:

TDP_PublisherBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation