Contains a list of characteristics. More...

Inheritance diagram for NXOpen.Routing.CharacteristicList:

Classes
struct	_CharacteristicInformation
	Contains the type and name of a characteristic

struct	CharacteristicInformation
	Contains the type and name of a characteristic More...

Public Member Functions
unsafe void	DeleteCharacteristic (string name, NXOpen.NXObject.AttributeType type)
	Removes a characteristic from the characteristic list. More...

unsafe NXOpen.Routing.CharacteristicList.CharacteristicInformation[]	GetCharacteristicTitlesByType (NXOpen.NXObject.AttributeType type)
	Returns the titles of all characteristics that have the specified type. More...

unsafe int	GetIntegerCharacteristic (string name)
	Gets the value of an integer characteristic. More...

unsafe double	GetRealCharacteristic (string name)
	Gets the value of a real characteristic. More...

unsafe string	GetStringCharacteristic (string name)
	Gets the value of a string characteristic More...

unsafe void	SetCharacteristic (string name, int value)
	Sets the value of an integer characteristic associated with the input name. More...

unsafe void	SetCharacteristic (string name, double value)
	Sets the value of an real characteristic associated with the input name. More...

unsafe void	SetCharacteristic (string name, string value)
	Sets the value of an string characteristic. More...

unsafe void	SetCharacteristic (string name, string value, NXOpen.NXObject.AttributeType type)
	Sets the value of a string or reference characteristic. 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 memory associated with this object. More...

Additional Inherited Members
Properties inherited from NXOpen.TransientObject
IntPtr	Handle `[get]`
	Handle of the internal object represented by this object. More...

Detailed Description

Contains a list of characteristics.

A characteristics is a name-value pair where the value can be an integer, real or string.

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Routing.CharacteristicList.DeleteCharacteristic	(	string	name,
		NXOpen.NXObject.AttributeType	type
	)

inline

Removes a characteristic from the characteristic list.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic
type	The type of the characteristic.

NXOpen.NXObject.AttributeType.Any is not valid.

See NXOpen.NXObject.AttributeType for more information.

override void NXOpen.Routing.CharacteristicList.FreeResource ( )

inlineprotectedvirtual

Frees the memory associated with this object.

Created in NX4.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe NXOpen.Routing.CharacteristicList.CharacteristicInformation [] NXOpen.Routing.CharacteristicList.GetCharacteristicTitlesByType ( NXOpen.NXObject.AttributeType type )

inline

Returns the titles of all characteristics that have the specified type.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

type	The characteristic type.

Specifying NXOpen.NXObject.AttributeType.Any returns the titles of all characteristics in the list.

See NXOpen.NXObject.AttributeType for more information.

Returns: The list of characteristic names.

unsafe int NXOpen.Routing.CharacteristicList.GetIntegerCharacteristic ( string name )

inline

Gets the value of an integer characteristic.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic.

Returns: The integer value of the characteristic.

unsafe double NXOpen.Routing.CharacteristicList.GetRealCharacteristic ( string name )

inline

Gets the value of a real characteristic.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic

Returns: The real value of the characteristic

unsafe string NXOpen.Routing.CharacteristicList.GetStringCharacteristic ( string name )

inline

Gets the value of a string characteristic

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic

Returns: The string value of the characteristic

unsafe void NXOpen.Routing.CharacteristicList.SetCharacteristic	(	string	name,
		int	value
	)

inline

Sets the value of an integer characteristic associated with the input name.

The method adds a new characteristic to the list if one does not exist already or converts the type of an existing characteristic to integer if necessary.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic
value	The integer value of the characteristic

unsafe void NXOpen.Routing.CharacteristicList.SetCharacteristic	(	string	name,
		double	value
	)

inline

Sets the value of an real characteristic associated with the input name.

The method adds a new characteristic to the list if one doesn't exist already or converts the type of an existing characteristic to real if necessary.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic
value	The real value of the characteristic

unsafe void NXOpen.Routing.CharacteristicList.SetCharacteristic	(	string	name,
		string	value
	)

inline

Sets the value of an string characteristic.

The method adds a new characteristic to the list if one does not exist already or converts the type of an existing characteristic to string if necessary.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic
value	The string value of the characteristic

unsafe void NXOpen.Routing.CharacteristicList.SetCharacteristic	(	string	name,
		string	value,
		NXOpen.NXObject.AttributeType	type
	)

inline

Sets the value of a string or reference characteristic.

The method adds a new characteristic to the list if one does not exist already or converts the type of an existing characteristic to string or reference if necessary.

Created in NX6.0.2

License requirements: routing_base ("Routing Basic")

Parameters

name	The name of the characteristic
value	The string value of the characteristic
type	The type of the characteristic, either string or reference type.

NXOpen.NXObject.AttributeType.Any is not valid.

See NXOpen.NXObject.AttributeType for more information.

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

Routing_CharacteristicList.cs

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation