Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

PMI::DimensionEntity Class Reference

#include <HUtilityPMI.h>

List of all members.

Public Member Functions

 DimensionEntity (HC_KEY segment_key=INVALID_KEY)
 DimensionEntity (DimensionEntity const &that)
Dimension::SubType GetDimensionSubType () const
Dimension::Type GetDimensionType () const
unsigned int GetStringCount () const
void GetStrings (unsigned int &out_count, String out_strings[], TextAttributes out_text_attributes[]) const
virtual Type GetType () const
DimensionEntity const & operator= (DimensionEntity const &that)
void Set (DimensionEntity const &that)
void SetDimensionSubType (Dimension::SubType const in_sub_type)
void SetDimensionType (Dimension::Type const in_type)
void SetStrings (unsigned int in_count, String const in_strings[], TextAttributes const in_text_attributes[])

Detailed Description

This class represents basic, reference or tolerance dimension.


Constructor & Destructor Documentation

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

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


Member Function Documentation

Dimension::SubType PMI::DimensionEntity::GetDimensionSubType ( ) const
Returns:
the dimension subtype of this DimensionEntity
Dimension::Type PMI::DimensionEntity::GetDimensionType ( ) const
Returns:
the dimension type of this DimensionEntity
unsigned int PMI::DimensionEntity::GetStringCount ( ) const
Returns:
the number of strings for this DimensionEntity
void PMI::DimensionEntity::GetStrings ( unsigned int &  out_count,
String  out_strings[],
TextAttributes  out_text_attributes[] 
) const

Gets the strings for this DimensionEntity.

Parameters:
out_countthe number of strings for this DimensionEntity. Returned to the user.
out_stringsthe array of strings for this DimensionEntity. 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 DimensionEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
virtual Type PMI::DimensionEntity::GetType ( ) const [inline, virtual]
Returns:
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

void PMI::DimensionEntity::SetDimensionSubType ( Dimension::SubType const  in_sub_type)

Sets the dimension subtype of this DimensionEntity. This will replace an existing dimension subtype.

void PMI::DimensionEntity::SetDimensionType ( Dimension::Type const  in_type)

Sets the dimension type of this DimensionEntity. This will replace an existing dimension type.

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

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

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

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