Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

PMI::RoughnessEntity Class Reference

#include <HUtilityPMI.h>

List of all members.

Public Member Functions

Roughness::Applicability::Type GetApplicabilityType () const
unsigned int GetFieldCount () const
void GetFields (unsigned int &out_count, String out_fields[], TextAttributes out_text_attributes[]) const
Roughness::Mode::Type GetModeType () const
Roughness::Obtention::Type GetObtentionType () const
virtual Type GetType () const
RoughnessEntity const & operator= (RoughnessEntity const &that)
 RoughnessEntity (HC_KEY segment_key=INVALID_KEY)
 RoughnessEntity (RoughnessEntity const &that)
void Set (RoughnessEntity const &that)
void SetApplicabilityType (Roughness::Applicability::Type const in_applicability_type)
void SetFields (unsigned int in_count, String const in_fields[], TextAttributes const in_text_attributes[])
void SetModeType (Roughness::Mode::Type const in_mode_type)
void SetObtentionType (Roughness::Obtention::Type const in_obtention_type)

Detailed Description

This class represents a roughness feature.


Constructor & Destructor Documentation

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

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


Member Function Documentation

Roughness::Applicability::Type PMI::RoughnessEntity::GetApplicabilityType ( ) const
Returns:
the applicability type of this RoughnessEntity
unsigned int PMI::RoughnessEntity::GetFieldCount ( ) const
Returns:
the number of fields for this RoughnessEntity
void PMI::RoughnessEntity::GetFields ( unsigned int &  out_count,
String  out_fields[],
TextAttributes  out_text_attributes[] 
) const

Gets the fields for this RoughnessEntity.

Parameters:
out_countthe number of fields for this RoughnessEntity. Returned to the user.
out_fieldsthe array of fields for this RoughnessEntity. 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 fields for this RoughnessEntity. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.
Roughness::Mode::Type PMI::RoughnessEntity::GetModeType ( ) const
Returns:
the mode type of this RoughnessEntity
Roughness::Obtention::Type PMI::RoughnessEntity::GetObtentionType ( ) const
Returns:
the obtention type of this RoughnessEntity
virtual Type PMI::RoughnessEntity::GetType ( ) const [inline, virtual]
Returns:
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

void PMI::RoughnessEntity::SetApplicabilityType ( Roughness::Applicability::Type const  in_applicability_type)

Sets the applicability type of this RoughnessEntity. This will replace an existing applicability type.

void PMI::RoughnessEntity::SetFields ( unsigned int  in_count,
String const  in_fields[],
TextAttributes const  in_text_attributes[] 
)

Sets the fields for this RoughnessEntity. These will replace any existing fields.

Parameters:
in_countthe number of fields in the array
in_fieldsthe array of fields for this RoughnessEntity
in_text_attributesthe array of TextAttributes for the fields for this RoughnessEntity
void PMI::RoughnessEntity::SetModeType ( Roughness::Mode::Type const  in_mode_type)

Sets the mode type of this RoughnessEntity. This will replace an existing mode type.

void PMI::RoughnessEntity::SetObtentionType ( Roughness::Obtention::Type const  in_obtention_type)

Sets the obtention type of this RoughnessEntity. This will replace an existing obtention type.


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