DphFormat::Block Class Reference

List of all members.

Detailed Description

Interface to a format block.

The Block class provides functionality to:


Public Member Functions

Operations
void setStyleAndLocation (const std::string &styleId, const std::string &locationId, const NXOpen::Point3d &point=NXOpen::Point3d())
void update ()
 Updates the block definition to what is on disk.
int appendEntry (const std::string &rowTypeId="")
void deleteEntry (int entry)
void placeSymbol (int entry, const std::string &type, const NXOpen::Point3d &point, const std::string &value="")
void beginUpdate ()
 Tell the block that field modification is about to occur.
void finishUpdate ()
 Tell the block that field modification is done.
Attributes
std::string identification () const
std::string styleId () const
std::string locationId () const
void setFieldValue (const std::string &fieldId, const std::string &value)
std::string fieldValue (const std::string &fieldId) const
int numberOfEntries () const
 Returns the number of entries on block.
std::string entryFieldValue (int entry, const std::string &fieldId) const
void setEntryFieldValue (int entry, const std::string &fieldId, const std::string &value)


Member Function Documentation

int DphFormat::Block::appendEntry ( const std::string &  rowTypeId = ""  ) 

Append an entry

Parameters:
[in] rowTypeId the ID of rowtype to use
Returns:
the index of the entry added

void DphFormat::Block::deleteEntry ( int  entry  ) 

Remove an entry

Parameters:
[in] entry the index of the entry to delete

std::string DphFormat::Block::entryFieldValue ( int  entry,
const std::string &  fieldId 
) const

Get value of an entry field

Parameters:
[in] entry the index of the entry
[in] fieldId the ID of the field
Returns:
the current value of entry field

std::string DphFormat::Block::fieldValue ( const std::string &  fieldId  )  const

Get a field's current value

Parameters:
[in] fieldId the ID of the field

std::string DphFormat::Block::identification (  )  const

Get ID of block

Returns:
the ID of block

std::string DphFormat::Block::locationId (  )  const

Get location ID of block

Returns:
the location ID of block

void DphFormat::Block::placeSymbol ( int  entry,
const std::string &  type,
const NXOpen::Point3d &  point,
const std::string &  value = "" 
)

Place an entry symbol on drawing

Parameters:
[in] entry the index of the entry
[in] type the symbol to add(blank to use first in block's list)
[in] point the location to place the symbol at
[in] value the value to use(empty string for default)
Note:
This will delete any existing entry's symbol

void DphFormat::Block::setEntryFieldValue ( int  entry,
const std::string &  fieldId,
const std::string &  value 
)

Set the value of an entry field

Parameters:
[in] entry the index of the entry
[in] fieldId the ID of the field to edit
[in] value the string to set field to

void DphFormat::Block::setFieldValue ( const std::string &  fieldId,
const std::string &  value 
)

Set the value of a field

Parameters:
[in] fieldId the ID of the field to edit
[in] value the string the set the field to

void DphFormat::Block::setStyleAndLocation ( const std::string &  styleId,
const std::string &  locationId,
const NXOpen::Point3d &  point = NXOpen::Point3d() 
)

Modify the style and location

Parameters:
[in] styleId the ID of the style to use
[in] locationId the ID of the location to use
[in] point the point to locate the block(used only for pick locations)

std::string DphFormat::Block::styleId (  )  const

Get style ID of block

Returns:
the style ID of block


Generated on Mon Oct 16 10:42:45 2006 for Delphi NX Drawing Format API by  doxygen 1.4.7