NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Fields::ExternalFileProfileBuilder Class Reference

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:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::IExternalFileReferencer

Public Types

enum  CyclicType { CyclicTypeNone, CyclicTypeXOnly, CyclicTypeYOnly, CyclicTypeBoth }
 Defines if the profile is repeating cyclically in any direction. More...
 
enum  DimensionChoice { DimensionChoiceCurve, DimensionChoiceSurface }
 the dimension of the profile More...
 
enum  Extrapolation { ExtrapolationLinear, ExtrapolationParabolic, ExtrapolationCubic }
 the extrapolation method used for the profile More...
 
enum  FormatOptions {
  FormatOptionsComputerRegionalSettings, FormatOptionsDotDecimalSeparator, FormatOptionsCommaDecimalSeparator, FormatOptionsDotDecimalSeparatorAndCommaValueDelimiter,
  FormatOptionsCommaDecimalSeparatorAndSemicolonValueDelimiter
}
 the format control method used for the profile More...
 
enum  Interpolation { InterpolationLinear, InterpolationAkima, InterpolationAkima72, InterpolationCubic }
 the interpolation method used for the profile More...
 

Public Member Functions

NXOpen::Fields::ExternalFileProfileBuilder::CyclicType Cyclic ()
 Returns. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice Dimension ()
 Returns. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const NXString &externalFileSpec)
 Establish the external reference to the given file specification. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
EstablishReference (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter::Type referenceType, const char *externalFileSpec)
 Establish the external reference to the given file specification. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions FormatControlOption ()
 Returns. More...
 
NXString GetColumnMeasureName (int columnNumber)
 Returns the measure of the specified column. More...
 
NXString GetColumnTitle (int columnNumber)
 Returns the title of the specified column. More...
 
NXOpen::UnitGetColumnUnit (int columnNumber)
 Returns the unit of the specified column. More...
 
virtual NXString GetExternalFileDefinitionKey (NXOpen::ExternalFileReferenceAdapter *adapter)
 Gets the file definition to use for external file adapter. More...
 
virtual
NXOpen::ExternalFileReferenceAdapter
GetExternalFileReferenceAdapter (int referenceObjectId)
 Returns the external file reference object. More...
 
int GetNumberOfColumns ()
 Gets the number of column titles. More...
 
int OrdinateColumn ()
 Returns. More...
 
NXOpen::ExpressionOrdinateOffset ()
 Returns. More...
 
NXOpen::ExpressionOrdinateScale ()
 Returns. More...
 
void SetCyclic (NXOpen::Fields::ExternalFileProfileBuilder::CyclicType cyclicType)
 Sets. More...
 
void SetDimension (NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice dimension)
 Sets. More...
 
virtual void SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen::ExternalFileReferenceAdapter *adapter)
 Sets the external file reference object. More...
 
void SetFormatControlOption (NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions formatControlType)
 Sets. More...
 
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...
 
void SetOrdinateColumn (int columnIdx)
 Sets. More...
 
void SetXColumn (int columnIdx)
 Sets. More...
 
void SetXExtrapolation (NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation extrapolation)
 Sets. More...
 
void SetXInterpolation (NXOpen::Fields::ExternalFileProfileBuilder::Interpolation interpolation)
 Sets. More...
 
void SetYColumn (int columnIdx)
 Sets. More...
 
void SetYExtrapolation (NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation extrapolation)
 Sets. More...
 
void SetYInterpolation (NXOpen::Fields::ExternalFileProfileBuilder::Interpolation interpolation)
 Sets. More...
 
NXOpen::ExpressionSlopeLeft ()
 Returns. More...
 
NXOpen::ExpressionSlopeRight ()
 Returns. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
int XColumn ()
 Returns. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation XExtrapolation ()
 Returns. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation XInterpolation ()
 Returns. More...
 
NXOpen::ExpressionXOffset ()
 Returns. More...
 
NXOpen::ExpressionXScale ()
 Returns. More...
 
int YColumn ()
 Returns. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation YExtrapolation ()
 Returns. More...
 
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation YInterpolation ()
 Returns. More...
 
NXOpen::ExpressionYOffset ()
 Returns. More...
 
NXOpen::ExpressionYScale ()
 Returns. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. 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::DimensionChoiceCurve (2D) or NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface (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::DimensionChoiceCurve you need to specify two columns from the file.

For NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface you need to specify three columns from the file.

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


Created in NX1847.0.0.

Member Enumeration Documentation

Defines if the profile is repeating cyclically in any direction.

This is overriding extrapolation if not set to NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeNone .

Enumerator
CyclicTypeNone 

not cyclic

CyclicTypeXOnly 

cyclic in x direction

CyclicTypeYOnly 

cyclic in y direction

CyclicTypeBoth 

cyclic in both x and y direction

the dimension of the profile

Enumerator
DimensionChoiceCurve 

two dimensional with x axis and ordinate

DimensionChoiceSurface 

three dimensional with x axis, y axis and ordinate

the extrapolation method used for the profile

Enumerator
ExtrapolationLinear 

Linear.

ExtrapolationParabolic 

Parabolic.

ExtrapolationCubic 

Cubic.

the format control method used for the profile

Enumerator
FormatOptionsComputerRegionalSettings 

Use Computer Regional Settings.

FormatOptionsDotDecimalSeparator 

Use .

as decimal separator

FormatOptionsCommaDecimalSeparator 

Use , as decimal separator.

FormatOptionsDotDecimalSeparatorAndCommaValueDelimiter 

Use .

as decimal separator and , as value delimiter

FormatOptionsCommaDecimalSeparatorAndSemicolonValueDelimiter 

Use , as decimal separator and ; as value delimiter.

the interpolation method used for the profile

Enumerator
InterpolationLinear 

Linear.

InterpolationAkima 

Akima.

InterpolationAkima72 

Akima72.

InterpolationCubic 

Cubic.

Member Function Documentation

NXOpen::Fields::ExternalFileProfileBuilder::CyclicType NXOpen::Fields::ExternalFileProfileBuilder::Cyclic ( )
NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice NXOpen::Fields::ExternalFileProfileBuilder::Dimension ( )
virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const NXString externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter::Type  referenceType,
const char *  externalFileSpec 
)
virtual

Establish the external reference to the given file specification.

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier to use for this reference if referencer has multiple external references
referenceTypethe kind of reference to establish
externalFileSpecthe external file specification.

Implements NXOpen::IExternalFileReferencer.

NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions NXOpen::Fields::ExternalFileProfileBuilder::FormatControlOption ( )
NXString NXOpen::Fields::ExternalFileProfileBuilder::GetColumnMeasureName ( int  columnNumber)

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.

Returns
measure name of the specified column
Created in NX1847.0.0.

License requirements : None
Parameters
columnNumbercolumn number, first column of the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference corresponding to 1
NXString NXOpen::Fields::ExternalFileProfileBuilder::GetColumnTitle ( int  columnNumber)

Returns the title of the specified column.


The title contains the

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.

Returns
title of the specified column
Created in NX1847.0.0.

License requirements : None
Parameters
columnNumbercolumn 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
NXOpen::Unit* NXOpen::Fields::ExternalFileProfileBuilder::GetColumnUnit ( int  columnNumber)

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.

Returns
unit of the specified column
Created in NX1847.0.0.

License requirements : None
Parameters
columnNumbercolumn number, first column of the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference corresponding to 1
virtual NXString NXOpen::Fields::ExternalFileProfileBuilder::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter adapter)
virtual

Gets the file definition to use for external file adapter.


Created in NX1847.0.0.

License requirements : None

Parameters
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::ExternalFileProfileBuilder::GetExternalFileReferenceAdapter ( int  referenceObjectId)
virtual

Returns the external file reference object.

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

Returns
external file reference object
Created in NX1847.0.0.

License requirements : None
Parameters
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references

Implements NXOpen::IExternalFileReferencer.

int NXOpen::Fields::ExternalFileProfileBuilder::GetNumberOfColumns ( )

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.

Returns
number of column titles
Created in NX1847.0.0.

License requirements : None
int NXOpen::Fields::ExternalFileProfileBuilder::OrdinateColumn ( )

Returns.

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 : None

NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::OrdinateOffset ( )

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 and NXOpen::Fields::ExternalFileProfileBuilder::SetOrdinateColumn in the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference .


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::OrdinateScale ( )

Returns.

the scale on the ordinate axis.

The scale is unitless.
Created in NX1847.0.0.

License requirements : None

void NXOpen::Fields::ExternalFileProfileBuilder::SetCyclic ( NXOpen::Fields::ExternalFileProfileBuilder::CyclicType  cyclicType)
void NXOpen::Fields::ExternalFileProfileBuilder::SetDimension ( NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice  dimension)

Sets.

the dimension.


Created in NX1847.0.0.

License requirements : None

Parameters
dimensiondimension
virtual void NXOpen::Fields::ExternalFileProfileBuilder::SetExternalFileReferenceAdapter ( int  referenceObjectId,
NXOpen::ExternalFileReferenceAdapter adapter 
)
virtual

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
referenceObjectIdthe unique identifier of the external reference required in case where referencer has multiple external references
adapterexternal file reference object

Implements NXOpen::IExternalFileReferencer.

void NXOpen::Fields::ExternalFileProfileBuilder::SetFormatControlOption ( NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions  formatControlType)
void NXOpen::Fields::ExternalFileProfileBuilder::SetMeasuresFixed ( bool  areMeasuresFixed)

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
areMeasuresFixedtrue, if changed measures should prevent a commit
void NXOpen::Fields::ExternalFileProfileBuilder::SetOrdinateColumn ( int  columnIdx)

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 : None

Parameters
columnIdxcolumnidx
void NXOpen::Fields::ExternalFileProfileBuilder::SetXColumn ( int  columnIdx)

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 : None

Parameters
columnIdxcolumnidx
void NXOpen::Fields::ExternalFileProfileBuilder::SetXExtrapolation ( NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation  extrapolation)
void NXOpen::Fields::ExternalFileProfileBuilder::SetXInterpolation ( NXOpen::Fields::ExternalFileProfileBuilder::Interpolation  interpolation)
void NXOpen::Fields::ExternalFileProfileBuilder::SetYColumn ( int  columnIdx)

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 and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface .


Created in NX1847.0.0.

License requirements : None

Parameters
columnIdxcolumnidx
void NXOpen::Fields::ExternalFileProfileBuilder::SetYExtrapolation ( NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation  extrapolation)
void NXOpen::Fields::ExternalFileProfileBuilder::SetYInterpolation ( NXOpen::Fields::ExternalFileProfileBuilder::Interpolation  interpolation)
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::SlopeLeft ( )
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::SlopeRight ( )
virtual bool NXOpen::Fields::ExternalFileProfileBuilder::Validate ( )
virtual

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.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

int NXOpen::Fields::ExternalFileProfileBuilder::XColumn ( )

Returns.

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 : None

NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation NXOpen::Fields::ExternalFileProfileBuilder::XExtrapolation ( )
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation NXOpen::Fields::ExternalFileProfileBuilder::XInterpolation ( )
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::XOffset ( )

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 and NXOpen::Fields::ExternalFileProfileBuilder::SetXColumn in the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference .


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::XScale ( )

Returns.

the scale on the x axis.

The scale is unitless.
Created in NX1847.0.0.

License requirements : None

int NXOpen::Fields::ExternalFileProfileBuilder::YColumn ( )

Returns.

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 and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface .


Created in NX1847.0.0.

License requirements : None

NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation NXOpen::Fields::ExternalFileProfileBuilder::YExtrapolation ( )
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation NXOpen::Fields::ExternalFileProfileBuilder::YInterpolation ( )
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::YOffset ( )

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 and NXOpen::Fields::ExternalFileProfileBuilder::SetYColumn in the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference .

This is only used when NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface .


Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::YScale ( )

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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.