Represents a NXOpen::Report::CommandBuilder . More...

Inheritance diagram for NXOpen::Report::CommandBuilder:

Public Types
enum	UserInputLocation { UserInputLocationBeforeAutomation, UserInputLocationAfterAutomation }
	Represents the user input location in command. More...

Public Member Functions
bool	Active ()
	Returns. More...

NXOpen::Report::BaseArgument *	AddArgument (NXOpen::Report::BaseArgument::Type argumentType)
	Adds an argument and adds it to the command. More...

NXOpen::Report::UserInput *	AddUserInput (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, NXOpen::Report::UserInput::Type userInputType)
	Adds an user input and adds it to command. More...

NXString	DisplayName ()
	Returns the command display name Created in NX11.0.0. More...

void	GetArguments (std::vector< NXOpen::Report::BaseArgument * > &pArguments)
	Gets all arguments in the command. More...

void	GetHint (std::vector< NXString > &commandHint)
	Gets the command hint Created in NX11.0.0. More...

void	GetNamespaces (std::vector< NXString > &pNamespaces)
	Gets the categories which command apply to. More...

void	GetUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, std::vector< NXOpen::Report::UserInput * > &pUserInputs)
	Gets all user inputs. More...

void	MoveUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, const std::vector< NXOpen::Report::UserInput * > &pUserInputs, bool isBeforeRefUserInput, NXOpen::Report::UserInput *pRefUserInputs)
	Moves the user inputs to the new position. More...

NXString	Name ()
	Returns the command name Created in NX11.0.0. More...

NXOpen::Report::ProgramInformation *	ProgramInformation ()
	Returns the automation program information object. More...

void	RemoveArguments (const std::vector< NXOpen::Report::BaseArgument * > &pArguments)
	Removes the arguments. More...

void	RemoveUserInputs (NXOpen::Report::CommandBuilder::UserInputLocation userInputLocation, const std::vector< NXOpen::Report::UserInput * > &pUserInputs)
	Removes the user inputs. More...

void	SetActive (bool isActive)
	Sets. More...

void	SetDisplayName (const NXString &displayName)
	Sets the command display name Created in NX11.0.0. More...

void	SetDisplayName (const char *displayName)
	Sets the command display name Created in NX11.0.0. More...

void	SetHint (std::vector< NXString > &commandHint)
	Sets the command hint Created in NX11.0.0. More...

void	SetName (const NXString &commandName)
	Sets the command name Created in NX11.0.0. More...

void	SetName (const char *commandName)
	Sets the command name Created in NX11.0.0. More...

void	SetNamespaces (std::vector< NXString > &pNamespaces)
	Sets the categories which command apply to. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

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

Detailed Description

Represents a NXOpen::Report::CommandBuilder .

To create a new instance of this class, use NXOpen::Report::CommandManager::CreateCommandBuilder

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Report::CommandBuilder::UserInputLocation

Represents the user input location in command.

Enumerator
UserInputLocationBeforeAutomation	The user item before automation.
UserInputLocationAfterAutomation	The user item after automation.

Member Function Documentation

bool NXOpen::Report::CommandBuilder::Active ( )

Returns.

a value that indicates whether the command is active or not.

Created in NX11.0.0.

License requirements : None

NXOpen::Report::BaseArgument* NXOpen::Report::CommandBuilder::AddArgument ( NXOpen::Report::BaseArgument::Type argumentType )

Adds an argument and adds it to the command.

Returns: Created in NX11.0.0.

License requirements : None

Parameters

argumentType argumenttype

NXOpen::Report::UserInput* NXOpen::Report::CommandBuilder::AddUserInput	(	NXOpen::Report::CommandBuilder::UserInputLocation	userInputLocation,
		NXOpen::Report::UserInput::Type	userInputType
	)

Adds an user input and adds it to command.

Returns: Created in NX11.0.0.

License requirements : None

Parameters

userInputLocation	userinputlocation
userInputType	userinputtype

NXString NXOpen::Report::CommandBuilder::DisplayName ( )

Returns the command display name
Created in NX11.0.0.

License requirements : None

void NXOpen::Report::CommandBuilder::GetArguments ( std::vector< NXOpen::Report::BaseArgument * > & pArguments )

Gets all arguments in the command.

Created in NX11.0.0.

License requirements : None

Parameters

pArguments parguments

void NXOpen::Report::CommandBuilder::GetHint ( std::vector< NXString > & commandHint )

Gets the command hint
Created in NX11.0.0.

License requirements : None

Parameters

commandHint commandhint

void NXOpen::Report::CommandBuilder::GetNamespaces ( std::vector< NXString > & pNamespaces )

Gets the categories which command apply to.

Created in NX11.0.0.

License requirements : None

Parameters

pNamespaces pnamespaces

void NXOpen::Report::CommandBuilder::GetUserInputs	(	NXOpen::Report::CommandBuilder::UserInputLocation	userInputLocation,
		std::vector< NXOpen::Report::UserInput * > &	pUserInputs
	)

Gets all user inputs.

Created in NX11.0.0.

License requirements : None

Parameters

userInputLocation	userinputlocation
pUserInputs	puserinputs

void NXOpen::Report::CommandBuilder::MoveUserInputs	(	NXOpen::Report::CommandBuilder::UserInputLocation	userInputLocation,
		const std::vector< NXOpen::Report::UserInput * > &	pUserInputs,
		bool	isBeforeRefUserInput,
		NXOpen::Report::UserInput *	pRefUserInputs
	)

Moves the user inputs to the new position.

Created in NX11.0.0.

License requirements : None

Parameters

userInputLocation	userinputlocation
pUserInputs	puserinputs
isBeforeRefUserInput	isbeforerefuserinput
pRefUserInputs	the target reference user input

NXString NXOpen::Report::CommandBuilder::Name ( )

Returns the command name
Created in NX11.0.0.

License requirements : None

NXOpen::Report::ProgramInformation* NXOpen::Report::CommandBuilder::ProgramInformation ( )

Returns the automation program information object.

Created in NX11.0.0.

License requirements : None

void NXOpen::Report::CommandBuilder::RemoveArguments ( const std::vector< NXOpen::Report::BaseArgument * > & pArguments )

Removes the arguments.

Created in NX11.0.0.

License requirements : None

Parameters

pArguments parguments

void NXOpen::Report::CommandBuilder::RemoveUserInputs	(	NXOpen::Report::CommandBuilder::UserInputLocation	userInputLocation,
		const std::vector< NXOpen::Report::UserInput * > &	pUserInputs
	)

Removes the user inputs.

Created in NX11.0.0.

License requirements : None

Parameters

userInputLocation	userinputlocation
pUserInputs	puserinputs

void NXOpen::Report::CommandBuilder::SetActive ( bool isActive )

Sets.

a value that indicates whether the command is active or not.

Created in NX11.0.0.

License requirements : None

Parameters

isActive isactive

void NXOpen::Report::CommandBuilder::SetDisplayName ( const NXString & displayName )

Sets the command display name
Created in NX11.0.0.

License requirements : None

Parameters

displayName displayname

void NXOpen::Report::CommandBuilder::SetDisplayName ( const char * displayName )

Sets the command display name
Created in NX11.0.0.

License requirements : None

Parameters

displayName displayname

void NXOpen::Report::CommandBuilder::SetHint ( std::vector< NXString > & commandHint )

Sets the command hint
Created in NX11.0.0.

License requirements : None

Parameters

commandHint commandhint

void NXOpen::Report::CommandBuilder::SetName ( const NXString & commandName )

Sets the command name
Created in NX11.0.0.

License requirements : None

Parameters

commandName commandname

void NXOpen::Report::CommandBuilder::SetName ( const char * commandName )

Sets the command name
Created in NX11.0.0.

License requirements : None

Parameters

commandName commandname

void NXOpen::Report::CommandBuilder::SetNamespaces ( std::vector< NXString > & pNamespaces )

Sets the categories which command apply to.

Created in NX11.0.0.

License requirements : None

Parameters

pNamespaces pnamespaces

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

Report_CommandBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation