NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Validate.Parameter Class Reference

Represents a NX NXOpen.Validate.Parameter . More...

Inheritance diagram for NXOpen.Validate.Parameter:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe bool GetBooleanValue ()
 Gets boolean type value from a single value parameter. More...
 
unsafe bool[] GetBooleanValues ()
 Gets boolean type values from a multi-value parameter. More...
 
unsafe double GetDoubleValue ()
 Gets real number type value from a single value parameter. More...
 
unsafe double[] GetDoubleValues ()
 Gets real number type values from a multi-value parameter. More...
 
unsafe int GetIntValue ()
 Gets integer number type value from a single value parameter. More...
 
unsafe int[] GetIntValues ()
 Gets integer number type values from a multi-value parameter. More...
 
unsafe NXOpen.Point3d GetPoint3dValue ()
 Gets Point3d type value from a single value parameter. More...
 
unsafe NXOpen.Point3d[] GetPoint3dValues ()
 Gets Point3d type values from a multi-value parameter. More...
 
unsafe string GetStringValue ()
 Gets string type value from a single value parameter. More...
 
unsafe string[] GetStringValues ()
 Gets string type values from a multi-value parameter. More...
 
unsafe NXOpen.Vector3d GetVector3dValue ()
 Gets Vector3d type value from a single value parameter. More...
 
unsafe NXOpen.Vector3d[] GetVector3dValues ()
 Gets Vector3d type values from a multi-value parameter. More...
 
unsafe bool IsList ()
 Finds out if a parameter is single value or multi-value. More...
 
unsafe void SetBooleanValue (bool data)
 Sets boolean type value to a single value parameter. More...
 
unsafe void SetBooleanValues (bool[] data)
 Sets boolean type values to a multi-value parameter. More...
 
unsafe void SetDoubleValue (double data)
 Sets real number type value to a single value parameter. More...
 
unsafe void SetDoubleValues (double[] data)
 Sets real number type values to a multi-value parameter. More...
 
unsafe void SetIntValue (int data)
 Sets integer number type value to a single value parameter. More...
 
unsafe void SetIntValues (int[] data)
 Sets integer number type values to a multi-value parameter. More...
 
unsafe void SetPoint3dValue (NXOpen.Point3d data)
 Sets Point3d type value to a single value parameter. More...
 
unsafe void SetPoint3dValues (NXOpen.Point3d[] data)
 Sets Point3d type values to a multi-value parameter. More...
 
unsafe void SetStringValue (string data)
 Sets string type value to a single value parameter. More...
 
unsafe void SetStringValues (string[] data)
 Sets string type values to a multi-value parameter. More...
 
unsafe void SetVector3dValue (NXOpen.Vector3d data)
 Sets Vector3d type value to a single value parameter. More...
 
unsafe void SetVector3dValues (NXOpen.Vector3d[] data)
 Sets Vector3d type values to a multi-value parameter. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new 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...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Properties

unsafe string Title [get]
 Returns the title string of the parameter. More...
 
unsafe NXOpen.RuleManager.RuleType Type [get]
 Returns the data type of a parameter. More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

Represents a NX NXOpen.Validate.Parameter .

A parameter is defined with a name, value formula and data type as well as whether the parameter can hold multiple values or single value and the data to build pull down menu or List selection dialogue to customize the values at runtime. Parameters are used to execute check logic.

Created in NX1899.0.0

Member Function Documentation

override void NXOpen.Validate.Parameter.FreeResource ( )
inlineprotectedvirtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX1899.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe bool NXOpen.Validate.Parameter.GetBooleanValue ( )
inline

Gets boolean type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The boolean type value.
unsafe bool [] NXOpen.Validate.Parameter.GetBooleanValues ( )
inline

Gets boolean type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The boolean type values.
unsafe double NXOpen.Validate.Parameter.GetDoubleValue ( )
inline

Gets real number type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The real number type value.
unsafe double [] NXOpen.Validate.Parameter.GetDoubleValues ( )
inline

Gets real number type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The real number type values.
unsafe int NXOpen.Validate.Parameter.GetIntValue ( )
inline

Gets integer number type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The integer number type value.
unsafe int [] NXOpen.Validate.Parameter.GetIntValues ( )
inline

Gets integer number type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The integer number type values.
unsafe NXOpen.Point3d NXOpen.Validate.Parameter.GetPoint3dValue ( )
inline

Gets Point3d type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
Point3d type value.
unsafe NXOpen.Point3d [] NXOpen.Validate.Parameter.GetPoint3dValues ( )
inline

Gets Point3d type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
Point3d type values.
unsafe string NXOpen.Validate.Parameter.GetStringValue ( )
inline

Gets string type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The string type value.
unsafe string [] NXOpen.Validate.Parameter.GetStringValues ( )
inline

Gets string type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
The string type values.
unsafe NXOpen.Vector3d NXOpen.Validate.Parameter.GetVector3dValue ( )
inline

Gets Vector3d type value from a single value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
Vector3d type value.
unsafe NXOpen.Vector3d [] NXOpen.Validate.Parameter.GetVector3dValues ( )
inline

Gets Vector3d type values from a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Returns
Vector3d type values.
unsafe bool NXOpen.Validate.Parameter.IsList ( )
inline

Finds out if a parameter is single value or multi-value.

True - multi-value list; false - single value.

Created in NX1899.0.0

License requirements: None.

Returns
unsafe void NXOpen.Validate.Parameter.SetBooleanValue ( bool  data)
inline

Sets boolean type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe boolean type value.
unsafe void NXOpen.Validate.Parameter.SetBooleanValues ( bool[]  data)
inline

Sets boolean type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe boolean type values.
unsafe void NXOpen.Validate.Parameter.SetDoubleValue ( double  data)
inline

Sets real number type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe real number type value.
unsafe void NXOpen.Validate.Parameter.SetDoubleValues ( double[]  data)
inline

Sets real number type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe real number type values.
unsafe void NXOpen.Validate.Parameter.SetIntValue ( int  data)
inline

Sets integer number type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe integer number type value.
unsafe void NXOpen.Validate.Parameter.SetIntValues ( int[]  data)
inline

Sets integer number type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe integer number type values.
unsafe void NXOpen.Validate.Parameter.SetPoint3dValue ( NXOpen.Point3d  data)
inline

Sets Point3d type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataPoint3d type value.
unsafe void NXOpen.Validate.Parameter.SetPoint3dValues ( NXOpen.Point3d[]  data)
inline

Sets Point3d type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataPoint3d type values.
unsafe void NXOpen.Validate.Parameter.SetStringValue ( string  data)
inline

Sets string type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe string type value.
unsafe void NXOpen.Validate.Parameter.SetStringValues ( string[]  data)
inline

Sets string type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataThe string type values.
unsafe void NXOpen.Validate.Parameter.SetVector3dValue ( NXOpen.Vector3d  data)
inline

Sets Vector3d type value to a single value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataVector3d type value.
unsafe void NXOpen.Validate.Parameter.SetVector3dValues ( NXOpen.Vector3d[]  data)
inline

Sets Vector3d type values to a multi-value parameter.

Created in NX1899.0.0

License requirements: None.

Parameters
dataVector3d type values.

Property Documentation

unsafe string NXOpen.Validate.Parameter.Title
get

Returns the title string of the parameter.

Created in NX1899.0.0

License requirements: None.

unsafe NXOpen.RuleManager.RuleType NXOpen.Validate.Parameter.Type
get

Returns the data type of a parameter.

Created in NX1899.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.