NXOpen::ExternalFileReferenceAdapter Class Reference

Represents a managed external file reference adapter object to communicate the external file reference information. More...

Inheritance diagram for NXOpen::ExternalFileReferenceAdapter:

Public Types
enum	Type { TypeNative, TypePart, TypeImanFile, TypeDatabaseObject }
	Indicates the type of external file reference. More...

Public Member Functions
void	EstablishReference (NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)
	Establish the managed reference to the given external file. More...
void	EstablishReference (NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)
	Establish the managed reference to the given external file. More...
NXString	GetFileSpec ()
	Returns external filespec from external file reference adapter. More...
void	SetAssociatedFileReference ()
	Set whether to the external file is an associated file of the part referencing it and it is applicable only when connected to teamcenter Created in NX1847.0.0. More...
void	SetCandidateForSave (bool doSave)
	Set whether to upload the modified external file into Teamcenter when part is getting saved and it is applicable only when connected to teamcenter Created in NX1847.0.0. More...
void	SetExternalFileDefinitionKey (const NXString &externalFileDefkey)
	Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference. More...
void	SetExternalFileDefinitionKey (const char *externalFileDefkey)
	Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a managed external file reference adapter object to communicate the external file reference information.

Use NXOpen::IExternalFileReferencer::GetExternalFileReferenceAdapter to get instance of this class.

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::ExternalFileReferenceAdapter::Type

Indicates the type of external file reference.

Enumerator
TypeNative	Represent a reference to file from native file system.
TypePart	Represent a reference to another NX part in Teamcenter database.
TypeImanFile	Represent a reference to named reference file from the Teamcenter database.
TypeDatabaseObject	Represent a reference to Teamcenter database object.

Member Function Documentation

void NXOpen::ExternalFileReferenceAdapter::EstablishReference	(	NXOpen::ExternalFileReferenceAdapter::Type	referenceType,
		const NXString &	externalFileSpec
	)

Establish the managed reference to the given external file.

Created in NX1847.0.0.

License requirements : None

Parameters

referenceType	referencetype
externalFileSpec	externalfilespec

void NXOpen::ExternalFileReferenceAdapter::EstablishReference	(	NXOpen::ExternalFileReferenceAdapter::Type	referenceType,
		const char *	externalFileSpec
	)

Establish the managed reference to the given external file.

Created in NX1847.0.0.

License requirements : None

Parameters

referenceType	referencetype
externalFileSpec	externalfilespec

NXString NXOpen::ExternalFileReferenceAdapter::GetFileSpec

(

)

Returns external filespec from external file reference adapter.

Created in NX1847.0.0.

License requirements : None

void NXOpen::ExternalFileReferenceAdapter::SetAssociatedFileReference

(

)

Set whether to the external file is an associated file of the part referencing it and it is applicable only when connected to teamcenter
Created in NX1847.0.0.

License requirements : None

void NXOpen::ExternalFileReferenceAdapter::SetCandidateForSave

(

bool

doSave

)

Set whether to upload the modified external file into Teamcenter when part is getting saved and it is applicable only when connected to teamcenter
Created in NX1847.0.0.

License requirements : None

Parameters

doSave

dosave

void NXOpen::ExternalFileReferenceAdapter::SetExternalFileDefinitionKey

(

const NXString &

externalFileDefkey

)

Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference.

Created in NX1847.0.0.

License requirements : None

Parameters

externalFileDefkey

externalfiledefkey

void NXOpen::ExternalFileReferenceAdapter::SetExternalFileDefinitionKey

(

const char *

externalFileDefkey

)

Set the ExternalFileDefinition which gives information about the TC data model and other managed mode specific aspects of this reference.

Created in NX1847.0.0.

License requirements : None

Parameters

externalFileDefkey

externalfiledefkey

---

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

• ExternalFileReferenceAdapter.hxx