Used to manage the interaction to Embed, Replace, Rename and Delete embedded file information in the part file. More...

Inheritance diagram for NXOpen::Features::EmbedManagerBuilder:

Public Types
enum	LocationTypes { LocationTypesOperatingSystem, LocationTypesTeamcenter }
	The option to specify where the file exists. More...

enum	TaskTypes { TaskTypesEmbed, TaskTypesReplace, TaskTypesRename, TaskTypesDelete }
	The task to perform on the file. More...

enum	UsageAreaTypes { UsageAreaTypesMathWorksheet }
	The area in the part file where the file is to be stored. More...

Public Member Functions
NXOpen::Features::EmbedManagerBuilder::UsageAreaTypes	Area ()
	Returns the area in the parts file which matches the application usage. More...

NXString	EmbedFileBrowser ()
	Returns the file browser to embed a new file into the part. More...

NXString	EmbedNativeFileBrowser ()
	Returns the native OS file browser to embed a new file into the part. More...

std::vector< int >	GetEmbeddedFile ()
	Get the index of the embedded file to process. More...

std::vector< NXString >	GetEmbeddedFileNames ()
	Get the embedded file names. More...

NXOpen::Features::EmbedManagerBuilder::LocationTypes	Location ()
	Returns the source location of the file. More...

NXString	NewNameFile ()
	Returns the new name for the embedded file. More...

NXString	ReplaceFileBrowser ()
	Returns the file browser to replace an embedded file into the part. More...

NXString	ReplaceNativeFileBrowser ()
	Returns the native OS file browser to replace an embedded file into the part. More...

void	SetArea (NXOpen::Features::EmbedManagerBuilder::UsageAreaTypes area)
	Sets the area in the parts file which matches the application usage. More...

void	SetEmbeddedFile (const std::vector< int > &embeddedFileIndex)
	Set the index of the embedded file to process. More...

void	SetEmbedFileBrowser (const NXString &filename)
	Sets the file browser to embed a new file into the part. More...

void	SetEmbedFileBrowser (const char *filename)
	Sets the file browser to embed a new file into the part. More...

void	SetEmbedNativeFileBrowser (const NXString &filename)
	Sets the native OS file browser to embed a new file into the part. More...

void	SetEmbedNativeFileBrowser (const char *filename)
	Sets the native OS file browser to embed a new file into the part. More...

void	SetLocation (NXOpen::Features::EmbedManagerBuilder::LocationTypes location)
	Sets the source location of the file. More...

void	SetNewNameFile (const NXString &newNameFile)
	Sets the new name for the embedded file. More...

void	SetNewNameFile (const char *newNameFile)
	Sets the new name for the embedded file. More...

void	SetReplaceFileBrowser (const NXString &filename)
	Sets the file browser to replace an embedded file into the part. More...

void	SetReplaceFileBrowser (const char *filename)
	Sets the file browser to replace an embedded file into the part. More...

void	SetReplaceNativeFileBrowser (const NXString &filename)
	Sets the native OS file browser to replace an embedded file into the part. More...

void	SetReplaceNativeFileBrowser (const char *filename)
	Sets the native OS file browser to replace an embedded file into the part. More...

void	SetTask (NXOpen::Features::EmbedManagerBuilder::TaskTypes type)
	Sets the task to be performed. More...

NXOpen::Features::EmbedManagerBuilder::TaskTypes	Task ()
	Returns the task to be performed. More...

Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::Feature *	CommitFeature ()
	Commits the feature parameters and creates the feature. More...

NXOpen::Features::Feature *	GetFeature ()
	Returns the feature currently being edited by this builder. More...

void	HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
	Re-suppress an internal parent feature (a slave feature) after it has been edited. More...

bool	ParentFeatureInternal ()
	Returns whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More...

bool	PatchSolutionFlag ()
	Returns the patch solution flag Created in NX8.0.1. More...

NXString	PatchSurfaceFilename ()
	Returns the patch surface filename Created in NX8.0.1. More...

void	SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the parent features which would be internal or slaves to the feature being created or commited Created in NX6.0.0. More...

void	SetParentFeatureInternal (bool isInternal)
	Sets whether or not the latest timestamped parent feature of this feature should be made internal Created in NX5.0.0. More...

void	SetPatchSolutionFlag (bool optionValue)
	Sets the patch solution flag Created in NX8.0.1. More...

void	SetPatchSurfaceFilename (const NXString &surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1. More...

void	SetPatchSurfaceFilename (const char *surfaceFilename)
	Sets the patch surface filename Created in NX8.0.1. More...

void	SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1. More...

void	SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
	Sets the surrounding patch surface filename Created in NX8.0.1. More...

void	ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
	Unsuppress an internal parent feature (a slave feature) so it can be edited. More...

NXString	SurroundingPatchSurfaceFilename ()
	Returns the surrounding patch surface filename Created in NX8.0.1. More...

void	UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
	Set the internal parent feature of the feature being edited to external Created in NX6.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

Used to manage the interaction to Embed, Replace, Rename and Delete embedded file information in the part file.

To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateEmbedManagerBuilder
Default values.

Property

Value

Area

MathWorksheet

Location

OperatingSystem

Task

Embed

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::Features::EmbedManagerBuilder::LocationTypes

The option to specify where the file exists.

Enumerator
LocationTypesOperatingSystem	File exists on the native OS.
LocationTypesTeamcenter	File exists in Teamcenter.

enum NXOpen::Features::EmbedManagerBuilder::TaskTypes

The task to perform on the file.

Enumerator
TaskTypesEmbed	Embed operating system file in part.
TaskTypesReplace	Replace the existing embedded file.
TaskTypesRename	Rename the existing embedded file.
TaskTypesDelete	Delete the existing embedded file.

enum NXOpen::Features::EmbedManagerBuilder::UsageAreaTypes

The area in the part file where the file is to be stored.

Enumerator
UsageAreaTypesMathWorksheet	Used by Symbolica and Maple applications.

Member Function Documentation

NXOpen::Features::EmbedManagerBuilder::UsageAreaTypes NXOpen::Features::EmbedManagerBuilder::Area ( )

Returns the area in the parts file which matches the application usage.

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::EmbedManagerBuilder::EmbedFileBrowser ( )

Returns the file browser to embed a new file into the part.

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::EmbedManagerBuilder::EmbedNativeFileBrowser ( )

Returns the native OS file browser to embed a new file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : None

std::vector<int> NXOpen::Features::EmbedManagerBuilder::GetEmbeddedFile ( )

Get the index of the embedded file to process.

May be multiple when deleting embedded data.

Returns: Index of embedded file to be processed
Created in NX12.0.0.

License requirements : None

std::vector<NXString> NXOpen::Features::EmbedManagerBuilder::GetEmbeddedFileNames ( )

Get the embedded file names.

The order is consistent with NXOpen::Features::EmbedManagerBuilder::GetEmbeddedFile indices.

Returns: Embedded file names corresponding to index usage.
Created in NX12.0.0.

License requirements : None

NXOpen::Features::EmbedManagerBuilder::LocationTypes NXOpen::Features::EmbedManagerBuilder::Location ( )

Returns the source location of the file.

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::EmbedManagerBuilder::NewNameFile ( )

Returns the new name for the embedded file.

Used when renaming the embedded file storage.
Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::EmbedManagerBuilder::ReplaceFileBrowser ( )

Returns the file browser to replace an embedded file into the part.

Created in NX12.0.0.

License requirements : None

NXString NXOpen::Features::EmbedManagerBuilder::ReplaceNativeFileBrowser ( )

Returns the native OS file browser to replace an embedded file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : None

void NXOpen::Features::EmbedManagerBuilder::SetArea ( NXOpen::Features::EmbedManagerBuilder::UsageAreaTypes area )

Sets the area in the parts file which matches the application usage.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

area area

void NXOpen::Features::EmbedManagerBuilder::SetEmbeddedFile ( const std::vector< int > & embeddedFileIndex )

Set the index of the embedded file to process.

May be multiple when deleting embedded data.
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

embeddedFileIndex Index of embedded file to process

void NXOpen::Features::EmbedManagerBuilder::SetEmbedFileBrowser ( const NXString & filename )

Sets the file browser to embed a new file into the part.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetEmbedFileBrowser ( const char * filename )

Sets the file browser to embed a new file into the part.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetEmbedNativeFileBrowser ( const NXString & filename )

Sets the native OS file browser to embed a new file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetEmbedNativeFileBrowser ( const char * filename )

Sets the native OS file browser to embed a new file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetLocation ( NXOpen::Features::EmbedManagerBuilder::LocationTypes location )

Sets the source location of the file.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

location location

void NXOpen::Features::EmbedManagerBuilder::SetNewNameFile ( const NXString & newNameFile )

Sets the new name for the embedded file.

Used when renaming the embedded file storage.
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

newNameFile newnamefile

void NXOpen::Features::EmbedManagerBuilder::SetNewNameFile ( const char * newNameFile )

Sets the new name for the embedded file.

Used when renaming the embedded file storage.
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

newNameFile newnamefile

void NXOpen::Features::EmbedManagerBuilder::SetReplaceFileBrowser ( const NXString & filename )

Sets the file browser to replace an embedded file into the part.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetReplaceFileBrowser ( const char * filename )

Sets the file browser to replace an embedded file into the part.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetReplaceNativeFileBrowser ( const NXString & filename )

Sets the native OS file browser to replace an embedded file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetReplaceNativeFileBrowser ( const char * filename )

Sets the native OS file browser to replace an embedded file into the part.

Used when the session is Teamcenter, but the location is NXOpen::Features::EmbedManagerBuilder::LocationTypesOperatingSystem .
Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

filename filename

void NXOpen::Features::EmbedManagerBuilder::SetTask ( NXOpen::Features::EmbedManagerBuilder::TaskTypes type )

Sets the task to be performed.

Created in NX12.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters

type type

NXOpen::Features::EmbedManagerBuilder::TaskTypes NXOpen::Features::EmbedManagerBuilder::Task ( )

Returns the task to be performed.

Created in NX12.0.0.

License requirements : None

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

Features_EmbedManagerBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation