Drawing Namespace Reference

Classes
class	BillLine
	No documentation available. More...
class	BOM
	No documentation available. More...
class	Drawing
	No documentation available. More...
class	DrawingReference
	No documentation available. More...
class	FileReference
	No documentation available. More...
class	SheetItem
	No documentation available. More...
class	SheetRevision
	No documentation available. More...

Functions
def	AdvanceMillPlotOrder
def	DescriptionPlotOrder
def	DetailExport
def	DetailSheetExport
def	ErectionSheetExport
def	ErectionViewExport
def	ExportPDF
def	GatherSheetExport
def	get_drawing_index
def	GetAllDetailNames
def	GetAllDetailReferrerNames
def	GetAllDetails
def	GetAllDetailSheetNames
def	GetAllDetailSheets
def	GetAllErectionSheetNames
def	GetAllErectionSheets
def	GetAllErectionViewNames
def	GetAllErectionViewReferrerNames
def	GetAllErectionViews
def	GetAllGatherSheetNames
def	GetAllGatherSheets
def	GetAllJobStandardReferrerNames
def	GetAllSubmaterial
def	GetAllSubmaterialNames
def	GetAllSubmaterialReferrerNames
def	GetDrawingPath
def	GlobalStandardExport
def	GradePlotOrder
def	IncrementSheetRevisionAlphabetically
def	IncrementSheetRevisionManually
def	IncrementSheetRevisionNumerically
def	JobStandardExport
def	LengthPlotOrder
def	LineNumberPlotOrder
def	make_sheet_item
def	MinorMarkPlotOrder
def	PiecemarkPlotOrder
def	RemarksPlotOrder
def	RevisionPlotOrder
def	Route1PlotOrder
def	Route2PlotOrder
def	Route3PlotOrder
def	SequencePlotOrder
def	SequenceQuantityPlotOrder
def	SubmaterialExport
def	TotalAreaPlotOrder
def	TotalQuantityPlotOrder
def	TotalWeightPlotOrder
def	UnitAreaPlotOrder
def	UnitQuantityPlotOrder
def	UnitWeightPlotOrder
def	update_geometry

Function Documentation

def Drawing.AdvanceMillPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.DescriptionPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.DetailExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.DetailSheetExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.ErectionSheetExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.ErectionViewExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.ExportPDF	(		drawings,
			filename,
			show_abm,
			plot_comments,
			plot_revision
	)

Returns

Instance of type None

     Example: ExportPDF(GetAllDetails(), "all_details.pdf", False, False, False)

def Drawing.GatherSheetExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.get_drawing_index	(		arg1,
			arg2
	)

Returns

Instance of type int

def Drawing.GetAllDetailNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllDetailReferrerNames

(

args

)

Returns

Instance of type dict

def Drawing.GetAllDetails

(

args

)

Returns

Instance of type list

def Drawing.GetAllDetailSheetNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllDetailSheets

(

args

)

Returns

Instance of type list

def Drawing.GetAllErectionSheetNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllErectionSheets

(

args

)

Returns

Instance of type list

def Drawing.GetAllErectionViewNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllErectionViewReferrerNames

(

args

)

Returns

Instance of type dict

def Drawing.GetAllErectionViews

(

args

)

Returns

Instance of type list

def Drawing.GetAllGatherSheetNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllGatherSheets

(

args

)

Returns

Instance of type list

def Drawing.GetAllJobStandardReferrerNames

(

args

)

Returns

Instance of type dict

def Drawing.GetAllSubmaterial

(

args

)

Returns

Instance of type list

def Drawing.GetAllSubmaterialNames

(

args

)

Returns

Instance of type list

def Drawing.GetAllSubmaterialReferrerNames

(

args

)

Returns

Instance of type dict

def Drawing.GetDrawingPath	(		arg1,
			arg2
	)

Returns

Instance of type str

def Drawing.GlobalStandardExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.GradePlotOrder

(

args

)

Returns

Instance of type str

def Drawing.IncrementSheetRevisionAlphabetically	(		sheet_reference,
			date_str = '**NOT SET**',
			description = '',
			user1 = '',
			user2 = '',
			user3 = '',
			user4 = ''
	)

Returns

Instance of type str

     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionAlphabetically
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionAlphabetically(sht_ref, 'now')
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]
     
 
     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionAlphabetically
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionAlphabetically(sht_ref, 0)
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]

Note

Additional signature: IncrementSheetRevisionAlphabetically( (DrawingReference)sheet_reference [, (object)date=0 [, (str)description='' [, (str)user1='' [, (str)user2='' [, (str)user3='' [, (str)user4='']]]]]]) -> str

def Drawing.IncrementSheetRevisionManually	(		sheet_reference,
			designation,
			date_str = '**NOT SET**',
			description = '',
			user1 = '',
			user2 = '',
			user3 = '',
			user4 = ''
	)

Returns

Instance of type str

     Increment the sheet with the specificed designation.
     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionManually
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionManually(sht_ref, '1', 0)
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]
     
 
     Increment the sheet with the specificed designation.
     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionManually
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionManually(sht_ref, '1', 'now')
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]

Note

Additional signature: IncrementSheetRevisionManually( (DrawingReference)sheet_reference, (str)designation [, (object)date=0 [, (str)description='' [, (str)user1='' [, (str)user2='' [, (str)user3='' [, (str)user4='']]]]]]) -> str

def Drawing.IncrementSheetRevisionNumerically	(		sheet_reference,
			date_str = '**NOT SET**',
			description = '',
			user1 = '',
			user2 = '',
			user3 = '',
			user4 = ''
	)

Returns

Instance of type str

     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionNumerically
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionNumerically(sht_ref, 'now')
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]
     
 
     Return the new revisions's designation if the sheet could be locked and revision created.
     Example:
     from Drawing import (
         GetAllDetailSheetNames
         , GetAllDetailSheets
         , Drawing
         , IncrementSheetRevisionNumerically
         )
     
     def GetRevisionDesignations(dwg):
         return [rev.designation for rev in dwg.GetRevisions()]
     
     for _, sht_ref in zip(GetAllDetailSheetNames(), GetAllDetailSheets()):
         orig_designations = GetRevisionDesignations(Drawing(sht_ref))
         new_designation = IncrementSheetRevisionNumerically(sht_ref, 0)
         assert GetRevisionDesignations(Drawing(sht_ref)) == orig_designations + [new_designation]

Note

Additional signature: IncrementSheetRevisionNumerically( (DrawingReference)sheet_reference [, (object)date=0 [, (str)description='' [, (str)user1='' [, (str)user2='' [, (str)user3='' [, (str)user4='']]]]]]) -> str

def Drawing.JobStandardExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.LengthPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.LineNumberPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.make_sheet_item	(		arg1,
			arg2,
			arg3,
			arg4,
			arg5,
			arg6,
			arg7,
			arg8
	)

Returns

Instance of type SheetItem

def Drawing.MinorMarkPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.PiecemarkPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.RemarksPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.RevisionPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.Route1PlotOrder

(

args

)

Returns

Instance of type str

def Drawing.Route2PlotOrder

(

args

)

Returns

Instance of type str

def Drawing.Route3PlotOrder

(

args

)

Returns

Instance of type str

def Drawing.SequencePlotOrder

(

args

)

Returns

Instance of type str

def Drawing.SequenceQuantityPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.SubmaterialExport	(		arg1,
			arg2
	)

Returns

Instance of type None

def Drawing.TotalAreaPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.TotalQuantityPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.TotalWeightPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.UnitAreaPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.UnitQuantityPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.UnitWeightPlotOrder

(

args

)

Returns

Instance of type str

def Drawing.update_geometry

(

arg1

)

Returns

Instance of type None