NXOpen::Fields::ImportBuilder Class Reference

Represents a Fields::ImportBuilder builder
To create a new instance of this class, use NXOpen::Fields::FieldManager::CreateImportBuilder
Default values. More...

Inheritance diagram for NXOpen::Fields::ImportBuilder:

Public Types
enum	ActionType {   ActionTypeImport, ActionTypeDontImport, ActionTypeImportAppend, ActionTypeReplace,   ActionTypeBackupAndReplace, ActionTypeImportPrepend }
	TODO: Add documentation for this enum and each of its members. More...
enum	ConflictType {   ConflictTypeNoConflict, ConflictTypeNameOnlyConflict, ConflictTypeNameOnlyConflictInUse, ConflictTypeCompatibleVariableConflict,   ConflictTypeCompatibleVariableConflictInUse, ConflictTypeIncompatibleVariableConflict, ConflictTypeIncompatibleVariableConflictInUse }
	TODO: Add documentation for this enum and each of its members. More...
enum	ImportConflictStrategy { ImportConflictStrategyAppendtoImportedFieldName, ImportConflictStrategyPrependStringtoImportedFieldName, ImportConflictStrategyUserSpecifiedReplaceandorRename }
	TODO: Add documentation for this enum and each of its members. More...
enum	ImportFieldStrategy {   ImportFieldStrategySkip, ImportFieldStrategyRenameExisting, ImportFieldStrategyRenameImported, ImportFieldStrategyReplace,   ImportFieldStrategyBackupReplace }
	TODO: Add documentation for this enum and each of its members. More...
enum	ImportFilter {   ImportFilterAll, ImportFilterFormula, ImportFilterTable, ImportFilterLinkedField,   ImportFilterTableofFields, ImportFilterFilterbyName, ImportFilterFilterbyDomain, ImportFilterFilterbyDependentVariableName,   ImportFilterFilterbyIndependentVariableName }
	TODO: Add documentation for this enum and each of its members. More...

Public Member Functions
NXOpen::Fields::ImportBuilder::ImportConflictStrategy	ConflictResolutionStrategy ()
	Returns the conflict resolution strategy Created in NX1847.0.0. More...
NXOpen::Fields::ImportBuilder::ImportFilter	FilterOptions ()
	Returns the filter options Created in NX1847.0.0. More...
NXString	FilterString ()
	Returns the filter string Created in NX1847.0.0. More...
int	GetImportAction (int nthField)
	Get the import action Created in NX1847.0.0. More...
NXOpen::Fields::Field *	ImportField ()
	Returns the import field Created in NX1847.0.0. More...
NXString	ImportFile ()
	Returns the import file Created in NX1847.0.0. More...
NXString	PrependString ()
	Returns the prepend string Created in NX1847.0.0. More...
void	SetConflictResolutionStrategy (NXOpen::Fields::ImportBuilder::ImportConflictStrategy conflictResolutionStrategy)
	Sets the conflict resolution strategy Created in NX1847.0.0. More...
void	SetFilterOptions (NXOpen::Fields::ImportBuilder::ImportFilter filterOptions)
	Sets the filter options Created in NX1847.0.0. More...
void	SetFilterString (const NXString &filterString)
	Sets the filter string Created in NX1847.0.0. More...
void	SetFilterString (const char *filterString)
	Sets the filter string Created in NX1847.0.0. More...
void	SetImportAction (int nthField, int action)
	Set the import action Created in NX1847.0.0. More...
void	SetImportField (NXOpen::Fields::Field *importField)
	Sets the import field Created in NX1847.0.0. More...
void	SetImportFile (const NXString &filename)
	Sets the import file Created in NX1847.0.0. More...
void	SetImportFile (const char *filename)
	Sets the import file Created in NX1847.0.0. More...
void	SetPrependString (const NXString &prependString)
	Sets the prepend string Created in NX1847.0.0. More...
void	SetPrependString (const char *prependString)
	Sets the prepend string 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

Represents a Fields::ImportBuilder builder
To create a new instance of this class, use NXOpen::Fields::FieldManager::CreateImportBuilder
Default values.

Property	Value
ConflictResolutionStrategy	AppendtoImportedFieldName
FilterOptions	All

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Fields::ImportBuilder::ActionType

TODO: Add documentation for this enum and each of its members.

Enumerator
ActionTypeImport	import
ActionTypeDontImport	dont import
ActionTypeImportAppend	import append
ActionTypeReplace	replace
ActionTypeBackupAndReplace	backup and replace
ActionTypeImportPrepend	import prepend

enum NXOpen::Fields::ImportBuilder::ConflictType

TODO: Add documentation for this enum and each of its members.

Enumerator
ConflictTypeNoConflict	no conflict
ConflictTypeNameOnlyConflict	name only conflict
ConflictTypeNameOnlyConflictInUse	name only conflict in use
ConflictTypeCompatibleVariableConflict	compatible variable conflict
ConflictTypeCompatibleVariableConflictInUse	compatible variable conflict in use
ConflictTypeIncompatibleVariableConflict	incompatible variable conflict
ConflictTypeIncompatibleVariableConflictInUse	incompatible variable conflict in use

enum NXOpen::Fields::ImportBuilder::ImportConflictStrategy

TODO: Add documentation for this enum and each of its members.

Enumerator
ImportConflictStrategyAppendtoImportedFieldName	appendto imported field name
ImportConflictStrategyPrependStringtoImportedFieldName	prepend stringto imported field name
ImportConflictStrategyUserSpecifiedReplaceandorRename	user specified replaceandor rename

enum NXOpen::Fields::ImportBuilder::ImportFieldStrategy

TODO: Add documentation for this enum and each of its members.

Enumerator
ImportFieldStrategySkip	skip
ImportFieldStrategyRenameExisting	rename existing
ImportFieldStrategyRenameImported	rename imported
ImportFieldStrategyReplace	replace
ImportFieldStrategyBackupReplace	backup replace

enum NXOpen::Fields::ImportBuilder::ImportFilter

TODO: Add documentation for this enum and each of its members.

Enumerator
ImportFilterAll	all
ImportFilterFormula	formula
ImportFilterTable	table
ImportFilterLinkedField	linked field
ImportFilterTableofFields	tableof fields
ImportFilterFilterbyName	filterby name
ImportFilterFilterbyDomain	filterby domain
ImportFilterFilterbyDependentVariableName	filterby dependent variable name
ImportFilterFilterbyIndependentVariableName	filterby independent variable name

Member Function Documentation

NXOpen::Fields::ImportBuilder::ImportConflictStrategy NXOpen::Fields::ImportBuilder::ConflictResolutionStrategy

(

)

Returns the conflict resolution strategy
Created in NX1847.0.0.

License requirements : None

NXOpen::Fields::ImportBuilder::ImportFilter NXOpen::Fields::ImportBuilder::FilterOptions

(

)

Returns the filter options
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Fields::ImportBuilder::FilterString

(

)

Returns the filter string
Created in NX1847.0.0.

License requirements : None

int NXOpen::Fields::ImportBuilder::GetImportAction

(

int

nthField

)

Get the import action
Created in NX1847.0.0.

License requirements : None

Parameters

nthField

nthfield

NXOpen::Fields::Field* NXOpen::Fields::ImportBuilder::ImportField

(

)

Returns the import field
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Fields::ImportBuilder::ImportFile

(

)

Returns the import file
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Fields::ImportBuilder::PrependString

(

)

Returns the prepend string
Created in NX1847.0.0.

License requirements : None

void NXOpen::Fields::ImportBuilder::SetConflictResolutionStrategy

(

NXOpen::Fields::ImportBuilder::ImportConflictStrategy

conflictResolutionStrategy

)

Sets the conflict resolution strategy
Created in NX1847.0.0.

License requirements : None

Parameters

conflictResolutionStrategy

conflictresolutionstrategy

void NXOpen::Fields::ImportBuilder::SetFilterOptions

(

NXOpen::Fields::ImportBuilder::ImportFilter

filterOptions

)

Sets the filter options
Created in NX1847.0.0.

License requirements : None

Parameters

filterOptions

filteroptions

void NXOpen::Fields::ImportBuilder::SetFilterString

(

const NXString &

filterString

)

Sets the filter string
Created in NX1847.0.0.

License requirements : None

Parameters

filterString

filterstring

void NXOpen::Fields::ImportBuilder::SetFilterString

(

const char *

filterString

)

Sets the filter string
Created in NX1847.0.0.

License requirements : None

Parameters

filterString

filterstring

void NXOpen::Fields::ImportBuilder::SetImportAction	(	int	nthField,
		int	action
	)

Set the import action
Created in NX1847.0.0.

License requirements : None

Parameters

nthField	nthfield
action	action

void NXOpen::Fields::ImportBuilder::SetImportField

(

NXOpen::Fields::Field *

importField

)

Sets the import field
Created in NX1847.0.0.

License requirements : None

Parameters

importField

field to reload

void NXOpen::Fields::ImportBuilder::SetImportFile

(

const NXString &

filename

)

Sets the import file
Created in NX1847.0.0.

License requirements : None

Parameters

filename

filename

void NXOpen::Fields::ImportBuilder::SetImportFile

(

const char *

filename

)

Sets the import file
Created in NX1847.0.0.

License requirements : None

Parameters

filename

filename

void NXOpen::Fields::ImportBuilder::SetPrependString

(

const NXString &

prependString

)

Sets the prepend string
Created in NX1847.0.0.

License requirements : None

Parameters

prependString

prependstring

void NXOpen::Fields::ImportBuilder::SetPrependString

(

const char *

prependString

)

Sets the prepend string
Created in NX1847.0.0.

License requirements : None

Parameters

prependString

prependstring

---

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

• Fields_ImportBuilder.hxx