NXOpen C++ Reference Guide
|
Represents a builder class for creating and editing an NXOpen::Fields::Field that is defined by an external file reference. More...
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... | |
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.
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 format control method used for the profile
NXOpen::Fields::ExternalFileProfileBuilder::CyclicType NXOpen::Fields::ExternalFileProfileBuilder::Cyclic | ( | ) |
Returns.
the cyclic type.
Created in NX1847.0.0.
License requirements : None
NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice NXOpen::Fields::ExternalFileProfileBuilder::Dimension | ( | ) |
Returns.
the dimension.
Created in NX1847.0.0.
License requirements : None
|
virtual |
Establish the external reference to the given file specification.
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. |
Implements NXOpen::IExternalFileReferencer.
|
virtual |
Establish the external reference to the given file specification.
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. |
Implements NXOpen::IExternalFileReferencer.
NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions NXOpen::Fields::ExternalFileProfileBuilder::FormatControlOption | ( | ) |
Returns.
the format control of separators
Created in NX1847.0.0.
License requirements : None
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.
columnNumber | column 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.
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 |
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.
columnNumber | column number, first column of the file set in NXOpen::Fields::ExternalFileProfileBuilder::EstablishReference corresponding to 1 |
|
virtual |
Gets the file definition to use for external file adapter.
Created in NX1847.0.0.
License requirements : None
adapter | external file reference object |
Implements NXOpen::IExternalFileReferencer.
|
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.
referenceObjectId | the 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.
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 | ) |
Sets.
the cyclic type.
Created in NX1847.0.0.
License requirements : None
cyclicType | cyclictype |
void NXOpen::Fields::ExternalFileProfileBuilder::SetDimension | ( | NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice | dimension | ) |
Sets.
the dimension.
Created in NX1847.0.0.
License requirements : None
dimension | dimension |
|
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
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.
void NXOpen::Fields::ExternalFileProfileBuilder::SetFormatControlOption | ( | NXOpen::Fields::ExternalFileProfileBuilder::FormatOptions | formatControlType | ) |
Sets.
the format control of separators
Created in NX1847.0.0.
License requirements : None
formatControlType | 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
areMeasuresFixed | true, 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
columnIdx | columnidx |
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
columnIdx | columnidx |
void NXOpen::Fields::ExternalFileProfileBuilder::SetXExtrapolation | ( | NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation | extrapolation | ) |
Sets.
the extrapolation in x direction.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::CyclicType and NXOpen::Fields::ExternalFileProfileBuilder::SetCyclicType is set to NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeNone or NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeYOnly
Created in NX1847.0.0.
License requirements : None
extrapolation | extrapolation |
void NXOpen::Fields::ExternalFileProfileBuilder::SetXInterpolation | ( | NXOpen::Fields::ExternalFileProfileBuilder::Interpolation | interpolation | ) |
Sets.
the interpolation in x direction.
Created in NX1847.0.0.
License requirements : None
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
columnIdx | columnidx |
void NXOpen::Fields::ExternalFileProfileBuilder::SetYExtrapolation | ( | NXOpen::Fields::ExternalFileProfileBuilder::Extrapolation | extrapolation | ) |
Sets.
the extrapolation in y direction.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface and when NXOpen::Fields::ExternalFileProfileBuilder::CyclicType and NXOpen::Fields::ExternalFileProfileBuilder::SetCyclicType is set to NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeNone or NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeXOnly
Created in NX1847.0.0.
License requirements : None
extrapolation | extrapolation |
void NXOpen::Fields::ExternalFileProfileBuilder::SetYInterpolation | ( | NXOpen::Fields::ExternalFileProfileBuilder::Interpolation | interpolation | ) |
Sets.
the interpolation in y direction.
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
interpolation | interpolation |
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::SlopeLeft | ( | ) |
Returns.
the left slope.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceCurve
Created in NX1847.0.0.
License requirements : None
NXOpen::Expression* NXOpen::Fields::ExternalFileProfileBuilder::SlopeRight | ( | ) |
Returns.
the right slope.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceCurve
Created in NX1847.0.0.
License requirements : None
|
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.
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 | ( | ) |
Returns.
the extrapolation in x direction.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::CyclicType and NXOpen::Fields::ExternalFileProfileBuilder::SetCyclicType is set to NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeNone or NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeYOnly
Created in NX1847.0.0.
License requirements : None
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation NXOpen::Fields::ExternalFileProfileBuilder::XInterpolation | ( | ) |
Returns.
the interpolation in x direction.
Created in NX1847.0.0.
License requirements : None
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 | ( | ) |
Returns.
the extrapolation in y direction.
This is only used when NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoice and NXOpen::Fields::ExternalFileProfileBuilder::SetDimensionChoice is set to NXOpen::Fields::ExternalFileProfileBuilder::DimensionChoiceSurface and when NXOpen::Fields::ExternalFileProfileBuilder::CyclicType and NXOpen::Fields::ExternalFileProfileBuilder::SetCyclicType is set to NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeNone or NXOpen::Fields::ExternalFileProfileBuilder::CyclicTypeXOnly
Created in NX1847.0.0.
License requirements : None
NXOpen::Fields::ExternalFileProfileBuilder::Interpolation NXOpen::Fields::ExternalFileProfileBuilder::YInterpolation | ( | ) |
Returns.
the interpolation in y direction.
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::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