DatumEntity

Functions

DatumEntity

DatumEntity

~DatumEntity

void

Set

DatumEntity const &

operator=

Type

GetType

Datum::Type

GetDatumType

void

SetDatumType

unsigned int

GetLabelCount

void

GetLabels

void

SetLabels

Detailed Description

class DatumEntity : public PMI::Entity

This class represents datum identifiers and datum targets.

Public Functions

DatumEntity(HC_KEY segment_key = (-1L))

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

DatumEntity(DatumEntity const &that)
virtual ~DatumEntity()
void Set(DatumEntity const &that)
DatumEntity const &operator=(DatumEntity const &that)
inline virtual Type GetType() const
Returns

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

Datum::Type GetDatumType() const
Returns

the datum type of this DatumEntity

void SetDatumType(Datum::Type const in_type)

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

unsigned int GetLabelCount() const
void GetLabels(unsigned int &out_count, String out_labels[], TextAttributes out_text_attributes[]) const

Gets the labels for this DatumEntity.

Parameters

  • out_count – the number of labels for this DatumEntity. Returned to the user.

  • out_labels – the 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_attributes – the 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.

void 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_count – the number of labels in the array

  • in_labels – the array of labels for this DatumEntity

  • in_text_attributes – the array of TextAttributes for the labels for this DatumEntity