view release on metacpan or  search on metacpan

ProEngineer.pm  view on Meta::CPAN

#
# CAD::ProEngineer::ProDimension package
#
package CAD::ProEngineer::ProDimension;



# Put package here again so autosplit does not get confused.
package CAD::ProEngineer;
1;
__END__
# Below is stub documentation for your module. You better edit it!

=head1 NAME

CAD::ProEngineer - Perl extension for the Pro/Engineer API (Pro/Toolkit)

=head1 SYNOPSIS

  use CAD::ProEngineer;
  blah blah blah

=head1 DESCRIPTION

This module implements a few Pro/Toolkit functions in perl.  There are two 
main components: an embedded imterpreter and an extension module.  The 
embedded interpreter can be found in the perl folder.  This is an early 
build so don't expect a flawless install to work, but the module works 
very well on Solaris and Windows.  It is not fully tested, so your mileage 
may vary.

Functions implemented (to be documented at a later time):

  ProMdlCurrentGet()
  ProMdlDelete()
  ProMdlDisplay()
  ProMdlErase()
  ProMdlEraseAll()
  ProMdlIdGet()
  ProMdlInit()
  ProMdlModificationVerify()
  ProMdlNameGet()
  ProMdlPostfixIdGet()
  ProSolidPostfixIdGet()
  ProMdlSessionIdGet()
  ProMdlSave()
  ProMdlSubtypeGet()
  ProMdlToModelitem()
  ProMdlTypeGet()
  ProMdlWindowGet()

  ProMessageClear()
  ProMessageDisplay()
  ProMessageDoubleRead()
  ProMessageIntegerRead()
  ProMessagePasswordRead()
  ProMessageStringRead()

  ProCmdActionAdd()
  ProMenubarmenuPushbuttonAdd()

  ProDimensionInit()
  ProDimensionSymbolGet()
  ProDimensionValueGet()
  ProSolidDimensionVisit()

  ProModelitemInit()
  ProModelitemMdlGet()

  ProParameterInit()
  ProParameterNameGet()
  ProParameterValueGet()
  ProParameterVisit()
  ProParamvalueValueGet()

  ProTreetoolRefresh()


  These can be used by three (or more) methods:

    Method #1:
      $retval = CAD::ProEngineer::ProMdlCurrentGet();

    Method #2:
      $o = new CAD::ProEngineer;
      $retval = $o->ProMdlCurrentGet($mdl);

    Method #2:
      $o = new CAD::ProEngineer;
      ($mdl,$retval) = $o->ProMdlCurrentGet();


Enum's available as perl subroutines:

  PRO_TK_NO_ERROR
  PRO_TK_GENERAL_ERROR
  PRO_TK_BAD_INPUTS
  PRO_TK_USER_ABORT
  PRO_TK_E_NOT_FOUND

  PRO_TK_E_FOUND
  PRO_TK_LINE_TOO_LONG
  PRO_TK_CONTINUE
  PRO_TK_BAD_CONTEXT
  PRO_TK_NOT_IMPLEMENTED

  PRO_TK_OUT_OF_MEMORY
  PRO_TK_COMM_ERROR
  PRO_TK_NO_CHANGE
  PRO_TK_SUPP_PARENTS
  PRO_TK_PICK_ABOVE

  PRO_TK_INVALID_DIR
  PRO_TK_INVALID_FILE
  PRO_TK_CANT_WRITE
  PRO_TK_INVALID_TYPE
  PRO_TK_INVALID_PTR

  PRO_TK_UNAV_SEC
  PRO_TK_INVALID_MATRIX