Entity

Functions

	Entity
	Entity
	~Entity
void	Set
Entity const &	operator=
Type	GetType
HC_KEY	GetSegmentKey
void	GetFrame
void	SetFrame
unsigned int	GetLeaderLineCount
void	GetLeaderLines
void	SetLeaderLines
unsigned int	GetLeaderSymbolCount
void	GetLeaderSymbols
void	SetLeaderSymbols
void	SetDisplayParallelToScreen
bool	IsDisplayParallelToScreen
void	GetDrawing
void	SetDrawing

Detailed Description

class Entity

This class is the base class for all the various PMI entity types. It contains functions common to all the PMI entities.

Subclassed by PMI::DatumEntity, PMI::DimensionEntity, PMI::FeatureControlFrameEntity, PMI::GenericEntity, PMI::NoteEntity, PMI::RoughnessEntity

Public Functions

Entity(HC_KEY segment_key = (-1L))

Constructs an Entity object. It requires specifying the segment key where the Entity will insert associated geometry.

Entity(Entity const &that)

virtual ~Entity()

void Set(Entity const &that)

Entity const &operator=(Entity const &that)

inline virtual Type GetType() const

Returns

the PMI::Type for this entity. Overridden by subclasses.

HC_KEY GetSegmentKey() const

Returns

the segment key where the Entity inserts associated geometry

void GetFrame(Frame &out_frame) const

Gets the Frame associated with this Entity. Returned to the user.

void SetFrame(Frame const &in_frame)

Sets the Frame associated with this Entity. This will replace an existing Frame.

unsigned int GetLeaderLineCount() const

Returns

the number of leaders lines for this Entity

void GetLeaderLines(unsigned int &out_count, Polyline out_leader_lines[]) const

Gets the leader lines for this Entity.

Parameters

• out_count – the number of leader lines for this Entity. Returned to the user.

• out_points – the array of leader lines for this Entity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

void SetLeaderLines(unsigned int in_count, Polyline const in_leader_lines[])

Sets the leader lines for this Entity. These will replace any existing leader lines.

Parameters

• in_count – the number of leader lines in the array

• in_polylines – the array of leader lines for this Entity

unsigned int GetLeaderSymbolCount() const

Returns

the number of leaders symbols for this Entity

void GetLeaderSymbols(unsigned int &out_count, Polygon out_leader_symbols[]) const

Gets the leader symbols for this Entity.

Parameters

• out_count – the number of leader symbols for this Entity. Returned to the user.

• out_points – the array of leader symbols for this Entity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

void SetLeaderSymbols(unsigned int in_count, Polygon const in_leader_symbols[])

Sets the leader symbols for this Entity. These will replace any existing leader symbols.

Parameters

• in_count – the number of leader symbols in the array

• in_polygons – the array of leader symbols for this Entity

void SetDisplayParallelToScreen(bool const in_parallel = true)

Set the option parallel to screen. The pmi is display parallel to screen and is not impacted by any rotation

bool IsDisplayParallelToScreen() const

Get the option parallel to screen value.

void GetDrawing(Drawing &out_drawing) const

Gets the Drawing associated with this Entity. Returned to the user.

void SetDrawing(Drawing const &in_drawing)

Sets the Drawing associated with this Entity. This will replace an existing Drawing.