Represents a builder class for creating and editing an NXOpen::Fields::Field . More...

Inheritance diagram for NXOpen::Fields::TimeSeriesProfileBuilder:

Public Types
enum	InterpolationEnum { InterpolationEnumLinear, InterpolationEnumAkima, InterpolationEnumAkima72, InterpolationEnumCubic }
	the interpolation method used for the profile More...

Public Member Functions
bool	ChannelHasMeasureUnknown ()
	Returns. More...

NXString	ChannelName ()
	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...

NXString	ExternalFile ()
	Returns. 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...

NXOpen::Fields::TimeSeriesProfileBuilder::InterpolationEnum	Interpolation ()
	Returns. More...

NXOpen::Expression *	Offset ()
	Returns. More...

NXOpen::Expression *	ScaleFactor ()
	Returns. More...

void	SetChannelHasMeasureUnknown (bool channelHasUnknownType)
	Sets. More...

void	SetChannelName (const NXString &channelName)
	Sets. More...

void	SetChannelName (const char *channelName)
	Sets. More...

void	SetExternalFile (const NXString &fileName)
	Sets. More...

void	SetExternalFile (const char *fileName)
	Sets. More...

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

void	SetInterpolation (NXOpen::Fields::TimeSeriesProfileBuilder::InterpolationEnum interpolation)
	Sets. More...

void	SetMeasureFixed (bool isMeasureFixed)
	If the measure is marked as fixed and is changed, the validation at commit will detect an error and fail. More...

void	SetUserDefinedUnitType (NXOpen::Unit *unitType)
	Sets. More...

NXOpen::Expression *	TimeDelta ()
	Returns. More...

NXOpen::Unit *	UserDefinedUnitType ()
	Returns. 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 builder class for creating and editing an NXOpen::Fields::Field .

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Fields::TimeSeriesProfileBuilder::InterpolationEnum

the interpolation method used for the profile

Enumerator
InterpolationEnumLinear	Linear.
InterpolationEnumAkima	Akima.
InterpolationEnumAkima72	Akima72.
InterpolationEnumCubic	Cubic.

Member Function Documentation

bool NXOpen::Fields::TimeSeriesProfileBuilder::ChannelHasMeasureUnknown ( )

Returns.

whether or not the profile has unknown measure

Created in NX1847.0.0.

License requirements : None

NXString NXOpen::Fields::TimeSeriesProfileBuilder::ChannelName ( )

Returns.

the channel name

Created in NX1847.0.0.

License requirements : None

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::TimeSeriesProfileBuilder::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

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 NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::TimeSeriesProfileBuilder::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

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.

NXString NXOpen::Fields::TimeSeriesProfileBuilder::ExternalFile ( )

Returns.

the external file.

Created in NX1847.0.0.

License requirements : None

virtual NXString NXOpen::Fields::TimeSeriesProfileBuilder::GetExternalFileDefinitionKey ( NXOpen::ExternalFileReferenceAdapter * adapter )

virtual

Gets the file definition to use for external file adapter.

Created in NX1847.0.0.

License requirements : None

Parameters

adapter external file reference object

Implements NXOpen::IExternalFileReferencer.

virtual NXOpen::ExternalFileReferenceAdapter* NXOpen::Fields::TimeSeriesProfileBuilder::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

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

Implements NXOpen::IExternalFileReferencer.

NXOpen::Fields::TimeSeriesProfileBuilder::InterpolationEnum NXOpen::Fields::TimeSeriesProfileBuilder::Interpolation ( )

Returns.

the interpolation

Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::TimeSeriesProfileBuilder::Offset ( )

Returns.

the offset on the x axis.

Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::TimeSeriesProfileBuilder::ScaleFactor ( )

Returns.

the scale factor

Created in NX1847.0.0.

License requirements : None

void NXOpen::Fields::TimeSeriesProfileBuilder::SetChannelHasMeasureUnknown ( bool channelHasUnknownType )

Sets.

whether or not the profile has unknown measure

Created in NX1847.0.0.

License requirements : None

Parameters

channelHasUnknownType channelhasunknowntype

void NXOpen::Fields::TimeSeriesProfileBuilder::SetChannelName ( const NXString & channelName )

Sets.

the channel name

Created in NX1847.0.0.

License requirements : None

Parameters

channelName channelname

void NXOpen::Fields::TimeSeriesProfileBuilder::SetChannelName ( const char * channelName )

Sets.

the channel name

Created in NX1847.0.0.

License requirements : None

Parameters

channelName channelname

void NXOpen::Fields::TimeSeriesProfileBuilder::SetExternalFile ( const NXString & fileName )

Sets.

the external file.

Created in NX1847.0.0.

License requirements : None

Parameters

fileName filename

void NXOpen::Fields::TimeSeriesProfileBuilder::SetExternalFile ( const char * fileName )

Sets.

the external file.

Created in NX1847.0.0.

License requirements : None

Parameters

fileName filename

virtual void NXOpen::Fields::TimeSeriesProfileBuilder::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

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::TimeSeriesProfileBuilder::SetInterpolation ( NXOpen::Fields::TimeSeriesProfileBuilder::InterpolationEnum interpolation )

Sets.

the interpolation

Created in NX1847.0.0.

License requirements : None

Parameters

interpolation interpolation

void NXOpen::Fields::TimeSeriesProfileBuilder::SetMeasureFixed ( bool isMeasureFixed )

If the measure is marked as fixed and is 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

isMeasureFixed true, if changed measures should prevent a commit

void NXOpen::Fields::TimeSeriesProfileBuilder::SetUserDefinedUnitType ( NXOpen::Unit * unitType )

Sets.

the user defined unit

Created in NX1847.0.0.

License requirements : None

Parameters

unitType unittype

NXOpen::Expression* NXOpen::Fields::TimeSeriesProfileBuilder::TimeDelta ( )

Returns.

the time delta

Created in NX1847.0.0.

License requirements : None

NXOpen::Unit* NXOpen::Fields::TimeSeriesProfileBuilder::UserDefinedUnitType ( )

Returns.

the user defined unit

Created in NX1847.0.0.

License requirements : None

virtual bool NXOpen::Fields::TimeSeriesProfileBuilder::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.

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

Fields_TimeSeriesProfileBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation