Alphabetical Class Index  Class Hierarchy   File Members   Compound Members   File List  

PMI::DatumEntity Class Reference

#include <HUtilityPMI.h>

List of all members.

Public Member Functions

 DatumEntity (HC_KEY segment_key=INVALID_KEY)
 DatumEntity (DatumEntity const &that)
Datum::Type GetDatumType () const
unsigned int GetLabelCount () const
void GetLabels (unsigned int &out_count, String out_labels[], TextAttributes out_text_attributes[]) const
virtual Type GetType () const
DatumEntity const & operator= (DatumEntity const &that)
void Set (DatumEntity const &that)
void SetDatumType (Datum::Type const in_type)
void SetLabels (unsigned int in_count, String const in_labels[], TextAttributes const in_text_attributes[])

Detailed Description

This class represents datum identifiers and datum targets.


Constructor & Destructor Documentation

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

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


Member Function Documentation

Datum::Type PMI::DatumEntity::GetDatumType ( ) const
Returns:
the datum type of this DatumEntity
void PMI::DatumEntity::GetLabels ( unsigned int &  out_count,
String  out_labels[],
TextAttributes  out_text_attributes[] 
) const

Gets the labels for this DatumEntity.

Parameters:
out_countthe number of labels for this DatumEntity. Returned to the user.
out_labelsthe array of labels for this DatumEntity. 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 labels for this DatumEntity. 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::DatumEntity::GetType ( ) const [inline, virtual]
Returns:
the PMI::Type for this entity. Overridden by subclasses.

Reimplemented from PMI::Entity.

void PMI::DatumEntity::SetDatumType ( Datum::Type const  in_type)

Sets the datum type of this DatumEntity. This will replace an existing datum type.

void PMI::DatumEntity::SetLabels ( unsigned int  in_count,
String const  in_labels[],
TextAttributes const  in_text_attributes[] 
)

Sets the labels for this DatumEntity. These will replace any existing labels.

Parameters:
in_countthe number of labels in the array
in_labelsthe array of labels for this DatumEntity
in_text_attributesthe array of TextAttributes for the labels for this DatumEntity

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