Interface for querying and setting characteristic (UG attribute values) on various routing objects. More...

Inheritance diagram for NXOpen::Routing::ICharacteristic:

Public Member Functions
virtual void	DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)=0
	Removes the input list of characteristics from this object.

virtual NXOpen::Routing::CharacteristicList *	GetCharacteristics ()=0
	Get all of the characteristics values on the this object.

virtual NXOpen::Routing::CharacteristicList *	GetDestinationCharacteristics ()=0
	Returns the destination characteristics from the input object.

virtual int	GetIntegerCharacteristic (const NXString &name)=0
	Get the value of an integer characteristic associated with the input name.

int	GetIntegerCharacteristic (const char *name)
	Get the value of an integer characteristic associated with the input name.

virtual double	GetRealCharacteristic (const NXString &name)=0
	Get the value of a real characteristic associated with the input name.

double	GetRealCharacteristic (const char *name)
	Get the value of a real characteristic associated with the input name.

virtual NXString	GetStringCharacteristic (const NXString &name)=0
	Get the value of a string characteristic associated with the input name.

NXString	GetStringCharacteristic (const char *name)
	Get the value of a string characteristic associated with the input name.

virtual void	SetCharacteristic (const NXString &name, int value)=0
	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char *name, int value)
	Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristic (const NXString &name, double value)=0
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char *name, double value)
	Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristic (const NXString &name, const NXString &value)=0
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

void	SetCharacteristic (const char name, const char value)
	Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

virtual void	SetCharacteristics (NXOpen::Routing::CharacteristicList *values)=0
	Set all of the characteristics values on this object.

Public Member Functions inherited from NXOpen::INXObject
virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)=0
	Finds the NXObject with the given identifier as recorded in a journal.

NXOpen::INXObject *	FindObject (const char *journalIdentifier)
	Finds the NXObject with the given identifier as recorded in a journal.

virtual bool	IsOccurrence ()=0
	Returns whether this object is an occurrence or not.

virtual NXString	JournalIdentifier ()=0
	Returns the identifier that would be recorded in a journal for this object.

virtual NXString	Name ()=0
	Returns the custom name of the object.

virtual NXOpen::Assemblies::Component *	OwningComponent ()=0
	Returns the owning component, if this object is an occurrence.

virtual NXOpen::BasePart *	OwningPart ()=0
	Returns the owning part of this object Created in NX3.0.0.

virtual void	Print ()=0
	Prints a representation of this object to the system log file.

virtual NXOpen::INXObject *	Prototype ()=0
	Returns the prototype of this object if it is an occurrence.

virtual void	SetName (const NXString &name)=0
	Sets the custom name of the object.

void	SetName (const char *name)
	Sets the custom name of the object.

Detailed Description

Interface for querying and setting characteristic (UG attribute values) on various routing objects.

These methods should be used instead of the attribute methods on the NXObject object in order to support extra functionality such as synonym characteristics available in the Routing application.
Created in NX4.0.0.

Member Function Documentation

virtual void NXOpen::Routing::ICharacteristic::DeleteCharacterstics ( NXOpen::Routing::CharacteristicList * values )

pure virtual

Removes the input list of characteristics from this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::ICharacteristic::GetCharacteristics ( )

pure virtual

Get all of the characteristics values on the this object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::ICharacteristic::GetDestinationCharacteristics ( )

pure virtual

Returns the destination characteristics from the input object.

         Retrieves the description of which destination characteristics to read
         from the application view and then reads those destination 
         characteristics from the object
         <ul>
             <li>Ports: Reads characteristics from the port.</li>
             <li>RCPs: Attempts to find a port at the RCP, reads characteristics from
                         the port if it exists, otherwise reads from the
                         stock associated with the rcp.</li>
             <li>Segments: Reads characteristics from the stock associated with the segment.</li>
             <li>Components: Reads characteristics directly from the component.</li>
             <li>Stock: Reads characteristics from the stock or from the stock's data.</li>
         </ul>
    @return

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

virtual int NXOpen::Routing::ICharacteristic::GetIntegerCharacteristic ( const NXString & name )

pure virtual

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

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

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

virtual double NXOpen::Routing::ICharacteristic::GetRealCharacteristic ( const NXString & name )

pure virtual

Get the value of a real characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Get the value of a real characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

virtual NXString NXOpen::Routing::ICharacteristic::GetStringCharacteristic ( const NXString & name )

pure virtual

Get the value of a string characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Get the value of a string characteristic associated with the input name.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

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

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

pure virtual

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

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

pure virtual

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	value

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

pure virtual

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	NOTE: The full Unicode character set is not supported for this parameter.

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

name	NOTE: The full Unicode character set is not supported for this parameter.
value	NOTE: The full Unicode character set is not supported for this parameter.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristics ( NXOpen::Routing::CharacteristicList * values )

pure virtual

Set all of the characteristics values on this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::RouteObject, and NXOpen::Routing::FittingOverstock.

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

Routing_ICharacteristic.hxx

Public Member Functions

Detailed Description

Member Function Documentation