PMI::GenericEntity Class Reference

#include <HUtilityPMI.h>

Public Member Functions

 GenericEntity (HC_KEY segment_key=INVALID_KEY)
 
 GenericEntity (GenericEntity const &that)
 
unsigned int GetStringCount () const
 
void GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const
 
virtual Type GetType () const
 
bool IsDisplayParallelToScreen () const
 
GenericEntity const & operator= (GenericEntity const &that)
 
void Set (GenericEntity const &that)
 
void SetDisplayParallelToScreen (bool const in_parallel=true)
 
void SetStrings (unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[])
 
- Public Member Functions inherited from PMI::Entity
 Entity (HC_KEY segment_key=INVALID_KEY)
 
 Entity (Entity const &that)
 
void GetDrawing (Drawing &out_drawing) const
 
void GetFrame (Frame &out_frame) const
 
unsigned int GetLeaderLineCount () const
 
void GetLeaderLines (unsigned int &out_count, Polyline out_leader_lines[]) const
 
unsigned int GetLeaderSymbolCount () const
 
void GetLeaderSymbols (unsigned int &out_count, Polygon out_leader_symbols[]) const
 
HC_KEY GetSegmentKey () const
 
bool IsDisplayParallelToScreen () const
 
Entity const & operator= (Entity const &that)
 
void Set (Entity const &that)
 
void SetDisplayParallelToScreen (bool const in_parallel=true)
 
void SetDrawing (Drawing const &in_drawing)
 
void SetFrame (Frame const &in_frame)
 
void SetLeaderLines (unsigned int in_count, Polyline const in_leader_lines[])
 
void SetLeaderSymbols (unsigned int in_count, Polygon const in_leader_symbols[])
 

Additional Inherited Members

- Protected Attributes inherited from PMI::Entity
PMII::PrivateImpl * impl_
 

Detailed Description

This class represents a generic PMI entity, i.e., any entity not represented by any other PMI entity.

Constructor & Destructor Documentation

◆ GenericEntity()

PMI::GenericEntity::GenericEntity ( HC_KEY  segment_key = INVALID_KEY)

Constructs a GenericEntity object. It requires specifying the segment key where the GenericEntity will insert associated geometry.

Member Function Documentation

◆ GetStringCount()

unsigned int PMI::GenericEntity::GetStringCount ( ) const
Returns
the number of strings for this GenericEntity

◆ GetStrings()

void PMI::GenericEntity::GetStrings ( unsigned int &  out_count,
String  out_strings[],
TextAttributes  out_text_attributes[] 
) const

Gets the strings for this GenericEntity.

Parameters
out_countthe number of strings for this GenericEntity. Returned to the user.
out_stringsthe array of strings for this GenericEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
out_text_attributesthe array of TextAttributes for the strings for this GenericEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

◆ GetType()

virtual Type PMI::GenericEntity::GetType ( ) const
inlinevirtual
Returns
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

◆ IsDisplayParallelToScreen()

bool PMI::GenericEntity::IsDisplayParallelToScreen ( ) const

Gets the display behavior for this GenericEntity.

Returns
option value

◆ SetDisplayParallelToScreen()

void PMI::GenericEntity::SetDisplayParallelToScreen ( bool const  in_parallel = true)

Sets the display behavior for this GenericEntity.

Parameters
in_paralleloption value

◆ SetStrings()

void PMI::GenericEntity::SetStrings ( unsigned int  in_count,
String const  in_strings[],
TextAttributes const  in_text_attributes[] 
)

Sets the strings for this GenericEntity. These will replace any existing strings.

Parameters
in_countthe number of strings in the array
in_stringsthe array of strings for this GenericEntity
in_text_attributesthe array of TextAttributes for the strings for this GenericEntity

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