ExPrcCommandContext Class

Syntax

C++

class ExPrcCommandContext : public OdPrcCommandContext, protected OdEdBaseUserIO, protected OdEdFunctionIO;

File

ExPrcCommandContext.h

Description

This class defines the interface for input/output operations and database access for samples of custom commands during their execution.

Example

For additional information, see OdPrcCommandContext class documentation.

Group

PRC Protocol Extensions Classes

OdPrcCommandContext Methods

	Name	Description
	database	Returns a database pointer for using in a custom command.
	dbUserIO	Returns the user IO object for this CommandContext object.

ExPrcCommandContext Class

	Name	Description
	arbitraryData	Reads the arbitrary data from the specified file within the command context object.
	baseDatabase	Returns the database associated with the command context object.
	baseFormatter	Returns the current unit base formatter for the command context object. The formatter is returned as a reference, therefore it can be used to change formatter settings.
	createObject	This is the overview for the createObject method overload.
	createRectFrame	Creates a rectangular frame from the specified point (base point) to the user input.
	createRubberBand	Creates a rubberband line from the specified point (base point) to the user input.
	funcIO	Returns the current object for implementing non-geometric interactive user input/output functionality for the command context.
	getAngle	Gets user input of an angle value from the command's input.
	getCmColor	Gets user input of a color value from the command's input.
	getDist	Gets user input of a distance value from the command's input.
	getFilePath	Gets user input of a distance value from the command's input.
	getInt	Gets user input of an integer value from the command's input.
	getKeyword	Gets user input of a keyword value from the command's input.
	getLASTPOINT	Returns the LASTPOINT system variable value for the command context object.
	getPoint	Gets user input of a point from the command's input.
	getReal	Gets user input of a real value from the command's input.
	getString	Gets user input of a string value from the command's input.
	param	Returns a parameter object for the command context object.
	previousSelection	Returns the selection set containing the previous selection data with the command context object.
	putString	Writes the specified string to the command's output.
	result	Returns the current result object for the command context object.
	setArbitraryData	Writes arbitrary data to the specified file with the command context object.
	setLASTPOINT	Sets a new value of the LASTPOINT system variable for this CommandContext object.
	setParam	Sets the parameter object for the command context object.
	setPreviousSelection	Sets the previous selection set for the command context object.
	setResult	Sets the result object for the command context object.
	userIO	Returns the current object for implementing user input/output operations for the command context.

Send feedback about this topic