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

Inheritance diagram for NXOpen.Fields.TimeSeriesProfileBuilder:

Public Types
enum	InterpolationEnum { 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	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 void	SetExternalFileReferenceAdapter (int referenceObjectId, NXOpen.ExternalFileReferenceAdapter adapter)
	Sets the external file reference object. More...

unsafe 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...

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 bool	ChannelHasMeasureUnknown `[get, set]`
	Returns or sets whether or not the profile has unknown measure More...

unsafe string	ChannelName `[get, set]`
	Returns or sets the channel name More...

unsafe string	ExternalFile `[get, set]`
	Returns or sets the external file. More...

unsafe NXOpen.Fields.TimeSeriesProfileBuilder.InterpolationEnum	Interpolation `[get, set]`
	Returns or sets the interpolation More...

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

unsafe NXOpen.Expression	ScaleFactor `[get]`
	Returns the scale factor More...

unsafe NXOpen.Expression	TimeDelta `[get]`
	Returns the time delta More...

unsafe NXOpen.Unit	UserDefinedUnitType `[get, set]`
	Returns or sets the user defined unit 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 .

Created in NX1847.0.0

Member Enumeration Documentation

enum NXOpen.Fields.TimeSeriesProfileBuilder.InterpolationEnum

the interpolation method used for the profile

Enumerator
Linear	Linear
Akima	Akima
Akima72	Akima72
Cubic	Cubic

Member Function Documentation

unsafe NXOpen.ExternalFileReferenceAdapter NXOpen.Fields.TimeSeriesProfileBuilder.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.TimeSeriesProfileBuilder.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.TimeSeriesProfileBuilder.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 void NXOpen.Fields.TimeSeriesProfileBuilder.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.TimeSeriesProfileBuilder.SetMeasureFixed ( bool isMeasureFixed )

inline

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

unsafe bool NXOpen.Fields.TimeSeriesProfileBuilder.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 bool NXOpen.Fields.TimeSeriesProfileBuilder.ChannelHasMeasureUnknown

getset

Returns or sets whether or not the profile has unknown measure

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Fields.TimeSeriesProfileBuilder.ChannelName

getset

Returns or sets the channel name

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Fields.TimeSeriesProfileBuilder.ExternalFile

getset

Returns or sets the external file.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.TimeSeriesProfileBuilder.InterpolationEnum NXOpen.Fields.TimeSeriesProfileBuilder.Interpolation

getset

Returns or sets the interpolation

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Fields.TimeSeriesProfileBuilder.Offset

get

Returns the offset on the x axis.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.TimeSeriesProfileBuilder.ScaleFactor

get

Returns the scale factor

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.TimeSeriesProfileBuilder.TimeDelta

get

Returns the time delta

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Unit NXOpen.Fields.TimeSeriesProfileBuilder.UserDefinedUnitType

getset

Returns or sets the user defined unit

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

Fields_TimeSeriesProfileBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation