The Top level routing data model object. More...

Inheritance diagram for NXOpen::Routing::RouteObject:

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

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

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

virtual int	GetIntegerCharacteristic (const NXString &name)
	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)
	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)
	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)
	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)
	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)
	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)
	Set all of the characteristics values on this object.

Public Member Functions inherited from NXOpen::Routing::RootObject
NXString	Guid ()
	Returns the object's Global Unique Identifier (GUID).

void	SetGuid (const NXString &guid)
	Sets the object's Global Unique Identifier (GUID).

void	SetGuid (const char *guid)
	Sets the object's Global Unique Identifier (GUID).

Public Member Functions inherited from NXOpen::NXObject
void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type)
	Deletes all attributes of a specific type.

void	DeleteAllAttributesByType (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes all attributes of a specific type with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title)
	Deletes an attribute by type and title.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const NXString &title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteAttributeByTypeAndTitle (NXOpen::NXObject::AttributeType type, const char *title, NXOpen::Update::Option option)
	Deletes an attribute by type and title with the option to update or not.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const NXString &title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttribute (NXOpen::NXObject::AttributeType type, const char *title, bool deleteEntireArray, NXOpen::Update::Option option)
	Deletes the first attribute encountered with the given Type, Title and Index.

void	DeleteUserAttributes (NXOpen::NXObject::AttributeType type, NXOpen::Update::Option option)
	Deletes the attributes encountered with the given Type with option to update or not.

virtual NXOpen::INXObject *	FindObject (const NXString &journalIdentifier)
	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.

std::vector < NXOpen::NXObject::AttributeInformation >	GetAttributeTitlesByType (NXOpen::NXObject::AttributeType type)
	Gets all the attribute titles of a specific type.

bool	GetBooleanUserAttribute (const NXString &title, int index)
	Gets a boolean attribute by Title and array Index.

bool	GetBooleanUserAttribute (const char *title, int index)
	Gets a boolean attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::ComputationalTime	GetComputationalTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

int	GetIntegerAttribute (const NXString &title)
	Gets an integer attribute by title.

int	GetIntegerAttribute (const char *title)
	Gets an integer attribute by title.

int	GetIntegerUserAttribute (const NXString &title, int index)
	Gets an integer attribute by Title and array Index.

int	GetIntegerUserAttribute (const char *title, int index)
	Gets an integer attribute by Title and array Index.

double	GetRealAttribute (const NXString &title)
	Gets a real attribute by title.

double	GetRealAttribute (const char *title)
	Gets a real attribute by title.

double	GetRealUserAttribute (const NXString &title, int index)
	Gets a real attribute by Title and array Index.

double	GetRealUserAttribute (const char *title, int index)
	Gets a real attribute by Title and array Index.

NXString	GetReferenceAttribute (const NXString &title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetReferenceAttribute (const char *title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string.

NXString	GetStringAttribute (const NXString &title)
	Gets a string attribute value by title.

NXString	GetStringAttribute (const char *title)
	Gets a string attribute value by title.

NXString	GetStringUserAttribute (const NXString &title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetStringUserAttribute (const char *title, int index)
	Gets a string attribute by Title and array Index.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const NXString &title)
	Gets a time attribute by title.

NXString	GetTimeAttribute (NXOpen::NXObject::DateAndTimeFormat format, const char *title)
	Gets a time attribute by title.

NXString	GetTimeUserAttribute (const NXString &title, int index)
	Gets a time attribute by Title and array Index.

NXString	GetTimeUserAttribute (const char *title, int index)
	Gets a time attribute by Title and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXOpen::NXObject::AttributeInformation	GetUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.

NXString	GetUserAttributeAsString (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

NXString	GetUserAttributeAsString (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index.

bool	GetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

bool	GetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type)
	Determine the lock of the given attribute.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes ()
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset)
	Gets all the attributes that have been set on the given object.

std::vector < NXOpen::NXObject::AttributeInformation >	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes that have been set on the given object.

std::vector< NXString >	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object.

std::vector< NXOpen::NXObject * >	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes.

bool	HasUserAttribute (const NXString &title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

bool	HasUserAttribute (const char *title, NXOpen::NXObject::AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object If the attribute is not an array, the Index is ignored (if this is known beforehand, we recommend setting the Index to -1 to save time).

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

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

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

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

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

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

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

void	SetAttribute (const NXString &title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const char *title, int value)
	Creates or modifies an integer attribute.

void	SetAttribute (const NXString &title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const char *title, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetAttribute (const NXString &title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const char *title, double value)
	Creates or modifies a real attribute.

void	SetAttribute (const NXString &title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const char *title, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute.

void	SetAttribute (const char title, const char value)
	Creates or modifies a string attribute.

void	SetAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetAttribute (const NXString &title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const char *title)
	Creates or modifies a null attribute which is an attribute with a title and no value.

void	SetAttribute (const NXString &title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetAttribute (const char *title, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetBooleanUserAttribute (const NXString &title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

void	SetBooleanUserAttribute (const char *title, int index, bool value, NXOpen::Update::Option option)
	Creates or modifies a boolean attribute with the option to update or not.

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

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

void	SetReferenceAttribute (const NXString &title, const NXString &value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const char title, const char value)
	Creates or modifies a string attribute which uses a reference string.

void	SetReferenceAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetReferenceAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not.

void	SetTimeAttribute (const NXString &title, const NXString &value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const char title, const char value)
	Creates or modifies a time attribute.

void	SetTimeAttribute (const NXString &title, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeAttribute (const char title, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const NXString &title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetTimeUserAttribute (const char *title, int index, const NXOpen::NXObject::ComputationalTime &value, NXOpen::Update::Option option)
	Creates or modifies a time attribute with the option to update or not.

void	SetUserAttribute (const NXOpen::NXObject::AttributeInformation &info, NXOpen::Update::Option option)
	Creates or modifies an attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, int value, NXOpen::Update::Option option)
	Creates or modifies an integer attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, double value, NXOpen::Update::Option option)
	Creates or modifies a real attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, const NXString &value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const char title, int index, const char value, NXOpen::Update::Option option)
	Creates or modifies a string attribute with the option to update or not.

void	SetUserAttribute (const NXString &title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttribute (const char *title, int index, NXOpen::Update::Option option)
	Creates or modifies a null attribute with the option to update or not.

void	SetUserAttributeLock (const NXString &title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

void	SetUserAttributeLock (const char *title, NXOpen::NXObject::AttributeType type, bool lock)
	Lock or unlock the given attribute.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

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

Public Member Functions inherited from NXOpen::Routing::ICharacteristic
int	GetIntegerCharacteristic (const char *name)
	Get the value of an integer characteristic associated with the input name.

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

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

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.

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.

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.

Additional Inherited Members
Public Types inherited from NXOpen::NXObject
enum	AttributeType { AttributeTypeInvalid, AttributeTypeNull, AttributeTypeBoolean, AttributeTypeInteger, AttributeTypeReal, AttributeTypeString, AttributeTypeTime, AttributeTypeReference, AttributeTypeAny = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { DateAndTimeFormatNumeric, DateAndTimeFormatTextual }
	Specifies the format of the date and time attribute. More...

Detailed Description

The Top level routing data model object.

    <br> 
   Provides each routing data model object with a unique identifier. 
   See NX Open Routing help for detailed information on the Connection data model.
    <br> 
 <br> Creator not available in KF.  <br>

Created in NX4.0.2.

Member Function Documentation

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

virtual

Removes the input list of characteristics from this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

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

virtual

Get all of the characteristics values on the this object.

Returns: Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implements NXOpen::Routing::ICharacteristic.

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

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")

Implements NXOpen::Routing::ICharacteristic.

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

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.

Implements NXOpen::Routing::ICharacteristic.

int NXOpen::Routing::RouteObject::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::RouteObject::GetRealCharacteristic ( const NXString & name )

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.

Implements NXOpen::Routing::ICharacteristic.

double NXOpen::Routing::RouteObject::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::RouteObject::GetStringCharacteristic ( const NXString & name )

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.

Implements NXOpen::Routing::ICharacteristic.

NXString NXOpen::Routing::RouteObject::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::RouteObject::SetCharacteristic	(	const NXString &	name,
		int	value
	)

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

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::RouteObject::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::RouteObject::SetCharacteristic	(	const NXString &	name,
		double	value
	)

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

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::RouteObject::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::RouteObject::SetCharacteristic	(	const NXString &	name,
		const NXString &	value
	)

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.

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::RouteObject::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::RouteObject::SetCharacteristics ( NXOpen::Routing::CharacteristicList * values )

virtual

Set all of the characteristics values on this object.

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters

values values

Implements NXOpen::Routing::ICharacteristic.

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

Routing_RouteObject.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation