Represents a builder class for creating and editing an NXOpen.Fields.Field that is defined by an external file reference. More...

Inheritance diagram for NXOpen.Fields.ExternalFileProfileBuilder:

Public Types
enum	CyclicType { None, XOnly, YOnly, Both }
	Defines if the profile is repeating cyclically in any direction. More...

enum	DimensionChoice { Curve, Surface, Any }
	the dimension of the profile More...

enum	Extrapolation { Linear, Parabolic, Cubic }
	the extrapolation method used for the profile More...

enum	FormatOptions { ComputerRegionalSettings, DotDecimalSeparator, CommaDecimalSeparator, DotDecimalSeparatorAndCommaValueDelimiter, CommaDecimalSeparatorAndSemicolonValueDelimiter }
	the format control method used for the profile More...

enum	Interpolation { Linear, Akima, Akima72, Cubic }
	the interpolation method used for the profile More...

Public Member Functions
unsafe NXOpen.ExternalFileReferenceAdapter	EstablishReference (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter.Type referenceType, string externalFileSpec)
	Establish the external reference to the given file specification. More...

unsafe string	GetColumnMeasureName (int columnNumber)
	Returns the measure of the specified column. More...

unsafe string	GetColumnTitle (int columnNumber)
	Returns the title of the specified column. More...

unsafe NXOpen.Unit	GetColumnUnit (int columnNumber)
	Returns the unit of the specified column. More...

unsafe string	GetExternalFileDefinitionKey (NXOpen.ExternalFileReferenceAdapter adapter)
	Gets the file definition to use for external file adapter. More...

unsafe NXOpen.ExternalFileReferenceAdapter	GetExternalFileReferenceAdapter (int referenceObjectId)
	Returns the external file reference object. More...

unsafe int	GetNumberOfColumns ()
	Gets the number of column titles. More...

unsafe void	SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
	Sets the external file reference object. More...

unsafe void	SetMeasuresFixed (bool areMeasuresFixed)
	If the measures are marked as fixed and they are changed, the validation at commit will detect an error and fail. More...

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Fields.ExternalFileProfileBuilder.CyclicType	Cyclic `[get, set]`
	Returns or sets the cyclic type. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice	Dimension `[get, set]`
	Returns or sets the dimension. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.FormatOptions	FormatControlOption `[get, set]`
	Returns or sets the format control of separators More...

unsafe int	OrdinateColumn `[get, set]`
	Returns or sets the column number in the external file corresponding to the ordinate axis. More...

unsafe NXOpen.Expression	OrdinateOffset `[get]`
	Returns the offset on the ordinate axis. More...

unsafe NXOpen.Expression	OrdinateScale `[get]`
	Returns the scale on the ordinate axis. More...

unsafe NXOpen.Expression	SlopeLeft `[get]`
	Returns the left slope. More...

unsafe NXOpen.Expression	SlopeRight `[get]`
	Returns the right slope. More...

unsafe int	XColumn `[get, set]`
	Returns or sets the column number in the external file corresponding to the x axis. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Extrapolation	XExtrapolation `[get, set]`
	Returns or sets the extrapolation in x direction. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Interpolation	XInterpolation `[get, set]`
	Returns or sets the interpolation in x direction. More...

unsafe NXOpen.Expression	XOffset `[get]`
	Returns the offset on the x axis. More...

unsafe NXOpen.Expression	XScale `[get]`
	Returns the scale on the x axis. More...

unsafe int	YColumn `[get, set]`
	Returns or sets the column number in the external file corresponding to the y axis. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Extrapolation	YExtrapolation `[get, set]`
	Returns or sets the extrapolation in y direction. More...

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Interpolation	YInterpolation `[get, set]`
	Returns or sets the interpolation in y direction. More...

unsafe NXOpen.Expression	YOffset `[get]`
	Returns the offset on the y axis. More...

unsafe NXOpen.Expression	YScale `[get]`
	Returns the scale on the y axis. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a builder class for creating and editing an NXOpen.Fields.Field that is defined by an external file reference.

This builder allows you to define an NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Curve (2D) or NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface (3D) profile from the data with an external file. The file must have at least the number of columns of data required for by the dimension of the profile to be created.

For NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Curve you need to specify two columns from the file.

NXOpen.Fields.ExternalFileProfileBuilder.XColumn , the independent value
NXOpen.Fields.ExternalFileProfileBuilder.OrdinateColumn , the dependent value

For NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface you need to specify three columns from the file.

NXOpen.Fields.ExternalFileProfileBuilder.XColumn , the independent value
NXOpen.Fields.ExternalFileProfileBuilder.YColumn , the independent value
NXOpen.Fields.ExternalFileProfileBuilder.OrdinateColumn , the dependent value

Please refer to documentation for specific details on the file formats supported.

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.Fields.ExternalFileProfileBuilder.CyclicType

Defines if the profile is repeating cyclically in any direction.

This is overriding extrapolation if not set to NXOpen.Fields.ExternalFileProfileBuilder.CyclicType.None .

Enumerator
None	not cyclic
XOnly	cyclic in x direction
YOnly	cyclic in y direction
Both	cyclic in both x and y direction

enum NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice

the dimension of the profile

Enumerator
Curve	two dimensional with x axis and ordinate
Surface	three dimensional with x axis, y axis and ordinate
Any	undefined dimension, which an existing profile can never actually have

enum NXOpen.Fields.ExternalFileProfileBuilder.Extrapolation

the extrapolation method used for the profile

Enumerator
Linear	Linear
Parabolic	Parabolic
Cubic	Cubic

enum NXOpen.Fields.ExternalFileProfileBuilder.FormatOptions

the format control method used for the profile

Enumerator
ComputerRegionalSettings	Use Computer Regional Settings
DotDecimalSeparator	Use . as decimal separator
CommaDecimalSeparator	Use , as decimal separator
DotDecimalSeparatorAndCommaValueDelimiter	Use . as decimal separator and , as value delimiter
CommaDecimalSeparatorAndSemicolonValueDelimiter	Use , as decimal separator and ; as value delimiter

enum NXOpen.Fields.ExternalFileProfileBuilder.Interpolation

the interpolation method used for the profile

Enumerator
Linear	Linear
Akima	Akima
Akima72	Akima72
Cubic	Cubic

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference	(	int	referenceObjectId,
		NXOpen.ExternalFileReferenceAdapter.Type	referenceType,
		string	externalFileSpec
	)

inline

Establish the external reference to the given file specification.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier to use for this reference if referencer has multiple external references
referenceType	the kind of reference to establish
externalFileSpec	the external file specification.

Returns: external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe string NXOpen.Fields.ExternalFileProfileBuilder.GetColumnMeasureName ( int columnNumber )

inline

Returns the measure of the specified column.

This only works if the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference is set to a valid file. (Please refer to documentation for specific details on the file formats supported.)
If the file was not read already GetColumnMeasureName will read it.

Created in NX1847.0.0

License requirements: None.

Parameters

columnNumber column number, first column of the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference corresponding to 1

Returns: measure name of the specified column

unsafe string NXOpen.Fields.ExternalFileProfileBuilder.GetColumnTitle ( int columnNumber )

inline

Returns the title of the specified column.

The title contains the

column number(s) in file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference (starting with 1)
end column for the variable if applicable
column name and
localized unit string.

e.g. "1: X (unitless)" or "2(..4): Y (mm)"

This only works if file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference is set to a valid file. (Please refer to documentation for specific details on the file formats supported.)
If the file was not read already GetColumnTitle will read it.

Created in NX1847.0.0

License requirements: None.

Parameters

columnNumber column number, first column of the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference corresponding to 1,
if several columns belong together to one variable all those columns will be considered as one common column

Returns: title of the specified column

unsafe NXOpen.Unit NXOpen.Fields.ExternalFileProfileBuilder.GetColumnUnit ( int columnNumber )

inline

Returns the unit of the specified column.

This only works if the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference is set to a valid file. (Please refer to documentation for specific details on the file formats supported.)
If the file was not read already GetColumnUnit will read it.

Created in NX1847.0.0

License requirements: None.

Parameters

columnNumber column number, first column of the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference corresponding to 1

Returns: unit of the specified column

unsafe string NXOpen.Fields.ExternalFileProfileBuilder.GetExternalFileDefinitionKey ( NXOpen.ExternalFileReferenceAdapter adapter )

inline

Gets the file definition to use for external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

adapter external file reference object

Returns

Implements NXOpen.IExternalFileReferencer.

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Fields.ExternalFileProfileBuilder.GetExternalFileReferenceAdapter ( int referenceObjectId )

inline

Returns the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to return the correct external file adapter.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId the unique identifier of the external reference required in case where referencer has multiple external references

Returns: external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe int NXOpen.Fields.ExternalFileProfileBuilder.GetNumberOfColumns ( )

inline

Gets the number of column titles.

Depending on the format of the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference several columns in the file can belong together making up one common title.

This only works if NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference is set to a valid file. (Please refer to documentation for specific details on the file formats supported.)
If the file was not read already GetNumberOfColumns will read it.

Created in NX1847.0.0

License requirements: None.

Returns: number of column titles

unsafe void NXOpen.Fields.ExternalFileProfileBuilder.SetExternalFileReferenceAdapter	(	int	referenceObjectId,
		NXOpen.ExternalFileReferenceAdapter	adapter
	)

inline

Sets the external file reference object.

In case the referencer object has multiple external references, use referenceObjectId to set the correct reference.

Created in NX1847.0.0

License requirements: None.

Parameters

referenceObjectId	the unique identifier of the external reference required in case where referencer has multiple external references
adapter	external file reference object

Implements NXOpen.IExternalFileReferencer.

unsafe void NXOpen.Fields.ExternalFileProfileBuilder.SetMeasuresFixed ( bool areMeasuresFixed )

inline

If the measures are marked as fixed and they are changed, the validation at commit will detect an error and fail.

It is recommended to call this method when editing a profile that is referenced by another object, which depends on specific measures.

Created in NX1847.0.0

License requirements: None.

Parameters

areMeasuresFixed true, if changed measures should prevent a commit

unsafe bool NXOpen.Fields.ExternalFileProfileBuilder.Validate ( )

inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns: Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Fields.ExternalFileProfileBuilder.CyclicType NXOpen.Fields.ExternalFileProfileBuilder.Cyclic

getset

Returns or sets the cyclic type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice NXOpen.Fields.ExternalFileProfileBuilder.Dimension

getset

Returns or sets the dimension.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.FormatOptions NXOpen.Fields.ExternalFileProfileBuilder.FormatControlOption

getset

Returns or sets the format control of separators

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Fields.ExternalFileProfileBuilder.OrdinateColumn

getset

Returns or sets the column number in the external file corresponding to the ordinate axis.

Column A of an excel file corresponds to the number 1.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.OrdinateOffset

get

Returns the offset on the ordinate axis.

The unit of the offset has to match the unit defined in the header of the NXOpen.Fields.ExternalFileProfileBuilder.OrdinateColumn in the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference .

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.OrdinateScale

get

Returns the scale on the ordinate axis.

The scale is unitless.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.SlopeLeft

get

Returns the left slope.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Curve

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.SlopeRight

get

Returns the right slope.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Curve

Created in NX1847.0.0

License requirements: None.

unsafe int NXOpen.Fields.ExternalFileProfileBuilder.XColumn

getset

Returns or sets the column number in the external file corresponding to the x axis.

Column A of an excel file corresponds to the number 1.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Extrapolation NXOpen.Fields.ExternalFileProfileBuilder.XExtrapolation

getset

Returns or sets the extrapolation in x direction.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.CyclicType is set to NXOpen.Fields.ExternalFileProfileBuilder.CyclicType.None or NXOpen.Fields.ExternalFileProfileBuilder.CyclicType.YOnly

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Interpolation NXOpen.Fields.ExternalFileProfileBuilder.XInterpolation

getset

Returns or sets the interpolation in x direction.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.XOffset

get

Returns the offset on the x axis.

The unit of the offset has to match the unit defined in the header of the NXOpen.Fields.ExternalFileProfileBuilder.XColumn in the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference .

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.XScale

get

Returns the scale on the x axis.

The scale is unitless.

Created in NX1847.0.0

License requirements: None.

unsafe int NXOpen.Fields.ExternalFileProfileBuilder.YColumn

getset

Returns or sets the column number in the external file corresponding to the y axis.

Column A of an excel file corresponds to the number 1.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface .

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Extrapolation NXOpen.Fields.ExternalFileProfileBuilder.YExtrapolation

getset

Returns or sets the extrapolation in y direction.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface and when NXOpen.Fields.ExternalFileProfileBuilder.CyclicType is set to NXOpen.Fields.ExternalFileProfileBuilder.CyclicType.None or NXOpen.Fields.ExternalFileProfileBuilder.CyclicType.XOnly

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.ExternalFileProfileBuilder.Interpolation NXOpen.Fields.ExternalFileProfileBuilder.YInterpolation

getset

Returns or sets the interpolation in y direction.

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.YOffset

get

Returns the offset on the y axis.

Please make sure that the unit of the offset matches the unit defined in the header of the NXOpen.Fields.ExternalFileProfileBuilder.YColumn in the file set in NXOpen.Fields.ExternalFileProfileBuilder.EstablishReference .

This is only used when NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice is set to NXOpen.Fields.ExternalFileProfileBuilder.DimensionChoice.Surface .

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.ExternalFileProfileBuilder.YScale

get

Returns the scale on the y axis.

The scale is unitless.

Created in NX1847.0.0

License requirements: None.

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

Fields_ExternalFileProfileBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation