Represents a user input in command. More...

Inheritance diagram for NXOpen::Report::UserInput:

Public Types
enum	Type { TypeText, TypeImages }
	Represents the user input type. More...

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

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

void	GetHint (std::vector< NXString > &inputHint)
	Gets the user input hint. More...

NXOpen::Report::UserInput::Type	InputType ()
	Returns the user input type. More...

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

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

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

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

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

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

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

void	SetHint (std::vector< NXString > &inputHint)
	Sets the user input hint. More...

void	SetInputType (NXOpen::Report::UserInput::Type inputType)
	Sets the user input type. More...

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a user input in command.

Not support KF.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Report::UserInput::Type

Represents the user input type.

Enumerator
TypeText	User input for text data.
TypeImages	User input for images data.

Member Function Documentation

virtual NXOpen::INXObject* NXOpen::Report::UserInput::FindObject ( const NXString & journalIdentifier )

virtual

Finds the NXOpen::NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

Implements NXOpen::INXObject.

virtual NXOpen::INXObject* NXOpen::Report::UserInput::FindObject ( const char * journalIdentifier )

virtual

Finds the NXOpen::NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns: Created in NX3.0.0.

License requirements : None

Parameters

journalIdentifier Journal identifier of the object

Implements NXOpen::INXObject.

void NXOpen::Report::UserInput::GetHint ( std::vector< NXString > & inputHint )

Gets the user input hint.

Created in NX11.0.0.

License requirements : None

Parameters

inputHint inputhint

NXOpen::Report::UserInput::Type NXOpen::Report::UserInput::InputType ( )

Returns the user input type.

Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::Report::UserInput::IsOccurrence ( )

virtual

Returns whether this object is an occurrence or not.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::Report::UserInput::JournalIdentifier ( )

virtual

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXString NXOpen::Report::UserInput::Name ( )

virtual

Returns the custom name of the object.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::Assemblies::Component* NXOpen::Report::UserInput::OwningComponent ( )

virtual

Returns the owning component, if this object is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::BasePart* NXOpen::Report::UserInput::OwningPart ( )

virtual

Returns the owning part of this object
Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual void NXOpen::Report::UserInput::Print ( )

virtual

Prints a representation of this object to the system log file.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

virtual NXOpen::INXObject* NXOpen::Report::UserInput::Prototype ( )

virtual

Returns the prototype of this object if it is an occurrence.

Created in NX3.0.0.

License requirements : None

Implements NXOpen::INXObject.

void NXOpen::Report::UserInput::SetHint ( std::vector< NXString > & inputHint )

Sets the user input hint.

Created in NX11.0.0.

License requirements : None

Parameters

inputHint inputhint

void NXOpen::Report::UserInput::SetInputType ( NXOpen::Report::UserInput::Type inputType )

Sets the user input type.

Created in NX11.0.0.

License requirements : None

Parameters

inputType inputtype

virtual void NXOpen::Report::UserInput::SetName ( const NXString & name )

virtual

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX3.0.0.

License requirements : None

Parameters

name name

Implements NXOpen::INXObject.

virtual void NXOpen::Report::UserInput::SetName ( const char * name )

virtual

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Created in NX3.0.0.

License requirements : None

Parameters

name name

Implements NXOpen::INXObject.

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

Report_UserInput.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation