Contains a list of characteristics. More...

Inheritance diagram for NXOpen::Routing::CharacteristicList:

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

Public Member Functions
void	DeleteCharacteristic (const NXString &name, NXOpen::NXObject::AttributeType type)
	Removes a characteristic from the characteristic list.

void	DeleteCharacteristic (const char *name, NXOpen::NXObject::AttributeType type)
	Removes a characteristic from the characteristic list.

std::vector < NXOpen::Routing::CharacteristicList::CharacteristicInformation >	GetCharacteristicTitlesByType (NXOpen::NXObject::AttributeType type)
	Returns the titles of all characteristics that have the specified type.

int	GetIntegerCharacteristic (const NXString &name)
	Gets the value of an integer characteristic.

int	GetIntegerCharacteristic (const char *name)
	Gets the value of an integer characteristic.

double	GetRealCharacteristic (const NXString &name)
	Gets the value of a real characteristic.

double	GetRealCharacteristic (const char *name)
	Gets the value of a real characteristic.

NXString	GetStringCharacteristic (const NXString &name)
	Gets the value of a string characteristic.

NXString	GetStringCharacteristic (const char *name)
	Gets the value of a string characteristic.

void	SetCharacteristic (const NXString &name, int value)
	Sets the value of an integer characteristic associated with the input name.

void	SetCharacteristic (const char *name, int value)
	Sets the value of an integer characteristic associated with the input name.

void	SetCharacteristic (const NXString &name, double value)
	Sets the value of an real characteristic associated with the input name.

void	SetCharacteristic (const char *name, double value)
	Sets the value of an real characteristic associated with the input name.

void	SetCharacteristic (const NXString &name, const NXString &value)
	Sets the value of an string characteristic.

void	SetCharacteristic (const char name, const char value)
	Sets the value of an string characteristic.

void	SetCharacteristic (const NXString &name, const NXString &value, NXOpen::NXObject::AttributeType type)
	Sets the value of a string or reference characteristic.

void	SetCharacteristic (const char name, const char value, NXOpen::NXObject::AttributeType type)
	Sets the value of a string or reference characteristic.

virtual	~CharacteristicList ()
	Frees the memory associated with this object.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

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.

Constructor & Destructor Documentation

virtual NXOpen::Routing::CharacteristicList::~CharacteristicList ( )

virtual

Frees the memory associated with this object.

Created in NX4.0.0.

License requirements : None

Member Function Documentation

void NXOpen::Routing::CharacteristicList::DeleteCharacteristic	(	const NXString &	name,
		NXOpen::NXObject::AttributeType	type
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
type	The type of the characteristic. NXObject::AttributeTypeAny is not valid. See NXObject::AttributeType for more information.

void NXOpen::Routing::CharacteristicList::DeleteCharacteristic	(	const char *	name,
		NXOpen::NXObject::AttributeType	type
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
type	The type of the characteristic. NXObject::AttributeTypeAny is not valid. See NXObject::AttributeType for more information.

std::vector<NXOpen::Routing::CharacteristicList::CharacteristicInformation> NXOpen::Routing::CharacteristicList::GetCharacteristicTitlesByType ( NXOpen::NXObject::AttributeType type )

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

Returns: The list of characteristic names.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

type	The characteristic type. Specifying AttributeType Any NXObject:: AttributeType Any returns the titles of all characteristics in the list. See NXObject::AttributeType for more information.

int NXOpen::Routing::CharacteristicList::GetIntegerCharacteristic ( const NXString & name )

Gets the value of an integer characteristic.

Returns: The integer value of the characteristic.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic. NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::Routing::CharacteristicList::GetIntegerCharacteristic ( const char * name )

Gets the value of an integer characteristic.

Returns: The integer value of the characteristic.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic. NOTE: The full Unicode character set is not supported for this parameter.

double NXOpen::Routing::CharacteristicList::GetRealCharacteristic ( const NXString & name )

Gets the value of a real characteristic.

Returns: The real value of the characteristic
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

double NXOpen::Routing::CharacteristicList::GetRealCharacteristic ( const char * name )

Gets the value of a real characteristic.

Returns: The real value of the characteristic
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::Routing::CharacteristicList::GetStringCharacteristic ( const NXString & name )

Gets the value of a string characteristic.

Returns: The string value of the characteristic
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

NXString NXOpen::Routing::CharacteristicList::GetStringCharacteristic ( const char * name )

Gets the value of a string characteristic.

Returns: The string value of the characteristic
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	The name of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const NXString &	name,
		int	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The integer value of the characteristic

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const char *	name,
		int	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The integer value of the characteristic

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const NXString &	name,
		double	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The real value of the characteristic

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const char *	name,
		double	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The real value of the characteristic

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const NXString &	name,
		const NXString &	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The string value of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const char *	name,
		const char *	value
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The string value of the characteristic NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const NXString &	name,
		const NXString &	value,
		NXOpen::NXObject::AttributeType	type
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The string value of the characteristic NOTE: The full Unicode character set is not supported for this parameter.
type	The type of the characteristic, either string or reference type. NXObject::AttributeTypeAny is not valid. See NXObject::AttributeType for more information.

void NXOpen::Routing::CharacteristicList::SetCharacteristic	(	const char *	name,
		const char *	value,
		NXOpen::NXObject::AttributeType	type
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
value	The string value of the characteristic NOTE: The full Unicode character set is not supported for this parameter.
type	The type of the characteristic, either string or reference type. NXObject::AttributeTypeAny is not valid. See NXObject::AttributeType for more information.

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

Routing_CharacteristicList.hxx

Classes

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation