OCC.Core.IGESData module¶

IGESData module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_igesdata.html

class IGESData_Array1OfDirPart(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class IGESData_Array1OfIGESEntity(*args)¶

Bases: object

Assign()¶

ChangeFirst()¶

ChangeLast()¶

ChangeValue()¶

First()¶

Init()¶

IsAllocated()¶

IsDeletable()¶

IsEmpty()¶

Last()¶

Length()¶

Lower()¶

Move()¶

Resize()¶

Set()¶

SetValue()¶

Size()¶

Upper()¶

Value()¶

begin()¶

cbegin()¶

cend()¶

end()¶

next()¶

property thisown¶: The membership flag

class IGESData_BasicEditor(*args)¶

Bases: object

Creates an empty Basic Editor which should be initialized via Init() method.

rtype

None* Creates a Basic Editor, with a new IGESModel, ready to run

param protocol

type protocol

IGESData_Protocol

rtype

None* Creates a Basic Editor for IGES Data, ready to run

param model

type model

IGESData_IGESModel

param protocol

type protocol

IGESData_Protocol

rtype

None

ApplyUnit()¶

Applies unit value to convert header dataResolution, MaxCoord, MaxLineWeight Applies unit only once after SetUnit… has been called, if <enforce> is given as True. It can be called just before writing the model to a file, i.e. when definitive values are finally known

param enforce

default value is Standard_False

type enforce

bool

rtype

None

AutoCorrect()¶

Performs auto-correction on an IGESEntity Returns True if something has changed, False if nothing done. //! Works with the specific IGES ServicesDirChecker which allows to correct data in ‘Directory Part’ of Entities (such as required values for status, or references to be null), and the specific IGES service OwnCorrect, which is specialised for each type of entity.

param ent

type ent

IGESData_IGESEntity

rtype

bool

AutoCorrectModel()¶

Performs auto-correction on the whole Model Returns the count of modified entities

rtype

int

ComputeStatus()¶

Performs the re-computation of status on the whole model (Subordinate Status and Use Flag of each IGES Entity), which can have required values according the way they are referenced (see definitions of Logical use, Physical use, etc…)

rtype

None

static DraftingMax()¶

Returns the maximum allowed value for Drafting Flag

rtype

int

static DraftingName()¶

From the flag of drafting standard, returns name, ‘’ if incorrect

param flag

type flag

int

rtype

char *

static IGESVersionMax()¶

Returns the maximum allowed value for IGESVersion Flag

rtype

int

static IGESVersionName()¶

From the flag of IGES version, returns name, ‘’ if incorrect

param flag

type flag

int

rtype

char *

Init()¶

Initialize a Basic Editor, with a new IGESModel, ready to run

param protocol

type protocol

IGESData_Protocol

rtype

None* Initialize a Basic Editor for IGES Data, ready to run

param model

type model

IGESData_IGESModel

param protocol

type protocol

IGESData_Protocol

rtype

None

Model()¶

Returns the designated model

rtype

opencascade::handle<IGESData_IGESModel>

SetUnitFlag()¶

Sets a new unit from its flag (param 14 of Global Section) Returns True if done, False if <flag> is incorrect

param flag

type flag

int

rtype

bool

SetUnitName()¶

Sets a new unit from its name (param 15 of Global Section) Returns True if done, False if <name> is incorrect Remarkif <flag> has been set to 3 (user defined), <name> is then free

param name

type name

char *

rtype

bool

SetUnitValue()¶

Sets a new unit from its value in meters (rounded to the closest one, max gap 1%) Returns True if done, False if <val> is too far from a suitable value

param val

type val

float

rtype

bool

static UnitFlagName()¶

From the flag of unit, determines its name, ‘’ if incorrect

param flag

type flag

int

rtype

char *

static UnitFlagValue()¶

From the flag of unit, determines value in MM, 0 if incorrect

param flag

type flag

int

rtype

float

static UnitNameFlag()¶

From the name of unit, computes flag number, 0 if incorrect (in this case, user defined entity remains possible)

param name

type name

char *

rtype

int

property thisown¶: The membership flag

class IGESData_ColorEntity¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_DefSwitch(*args)¶

Bases: object

creates a DefSwitch as Void

rtype

None

DefType()¶

returns DefType status (Void,Reference,Rank)

rtype

IGESData_DefType

SetRank()¶

sets DefSwitch to ‘Rank’ with a Value (in fileInteger > 0)

param val

type val

int

rtype

None

SetReference()¶

sets DefSwitch to ‘Reference’ Status (in fileInteger < 0)

rtype

None

SetVoid()¶

sets DefSwitch to ‘Void’ status (in fileInteger = 0)

rtype

None

Value()¶

returns Value as Integer (sensefull for a Rank)

rtype

int

property thisown¶: The membership flag

class IGESData_DefaultGeneral(*args)¶

Bases: OCC.Core.IGESData.IGESData_GeneralModule

Creates a DefaultGeneral and puts it into GeneralLib, bound with a Protocol from IGESData

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_DefaultSpecific(*args)¶

Bases: OCC.Core.IGESData.IGESData_SpecificModule

Creates a DefaultSpecific and puts it into SpecificLib

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_DirChecker(*args)¶

Bases: object

Returns a DirChecker, with no criterium at all to be checked

rtype

None* Returns a DirChecker, with no criterium except Required Type

param atype

type atype

int

rtype

None* Returns a DirChecker, with no criterium except Required values for Type and Form numbers

param atype

type atype

int

param aform

type aform

int

rtype

None* Returns a DirChecker, with no criterium except Required values for Type number (atype), and Required Range for Form number (which must be between aform1 and aform2 included)

param atype

type atype

int

param aform1

type aform1

int

param aform2

type aform2

int

rtype

None

BlankStatusIgnored()¶

Sets Blank Status to be ignored (should not be defined, or its value should be 0)

rtype

None

BlankStatusRequired()¶

Sets Blank Status to be required at a given value

param val

type val

int

rtype

None

Check()¶

Performs the Checks on an IGESEntity, according to the recorded criteria In addition, does minimal Checks, such as admitted range for Status, or presence of Error status in some data (Color, …)

param ach

type ach

Interface_Check

param ent

type ent

IGESData_IGESEntity

rtype

None

CheckTypeAndForm()¶

Performs a Check only on Values of Type Number and Form Number This allows to do a check on an Entity not yet completely filled but of which Type and Form Number have been already set

param ach

type ach

Interface_Check

param ent

type ent

IGESData_IGESEntity

rtype

None

Color()¶

Sets Color criterium If crit is DefVoid, Ignoredshould not be defined If crit is DefAny, Requiredmust be defined (value or ref) Other values are not taken in account

param crit

type crit

IGESData_DefType

rtype

None

Correct()¶

Corrects the Directory Entry of an IGES Entity as far as it is possible according recorded criteria without any ambiguity- if a numeric Status is required a given value, this value is enforced - if an item is required to be Void, or if it recorded as Erroneous, it is cleared (set to Void) - Type Number is enforced - finally Form Number is enforced only if one and only Value is admitted (no range, see Constructors of DirChecker)

param ent

type ent

IGESData_IGESEntity

rtype

bool

GraphicsIgnored()¶

Sets Graphics data (LineFont, LineWeight, Color, Level, View) to be ignored according value of Hierarchy statusIf hierarchy is not given, they are Ignored any way (that is, they should not be defined) If hierarchy is given, Graphics are Ignored if the Hierarchy status has the value given in argument ‘hierarchy’

param hierarchy

default value is -1

type hierarchy

int

rtype

None

HierarchyStatusIgnored()¶

Sets Hierarchy Status to be ignored (should not be defined, or its value should be 0)

rtype

None

HierarchyStatusRequired()¶

Sets Hierarchy Status to be required at a given value

param val

type val

int

rtype

None

IsSet()¶

Returns True if at least one criterium has already been set Allows user to store a DirChecker (static variable) then ask if it has been set before setting it

rtype

bool

LineFont()¶

Sets LineFont criterium If crit is DefVoid, Ignoredshould not be defined If crit is DefAny, Requiredmust be defined (value or ref) If crit is DefValue, Required as a Value (error if Reference) Other values are not taken in account

param crit

type crit

IGESData_DefType

rtype

None

LineWeight()¶

Sets LineWeight criterium If crit is DefVoid, Ignoredshould not be defined If crit is DefValue, Required Other values are not taken in account

param crit

type crit

IGESData_DefType

rtype

None

SetDefault()¶

Sets a DirChecker with most current criteria, that isStructure Ignored ( worths call Structure(crit = DefVoid) )

rtype

None

Structure()¶

Sets Structure criterium. If crit is DefVoid, Ignoredshould not be defined If crit is DefReference, Requiredmust be defined Other values are not taken in account

param crit

type crit

IGESData_DefType

rtype

None

SubordinateStatusIgnored()¶

Sets Subordinate Status to be ignored (should not be defined, or its value should be 0)

rtype

None

SubordinateStatusRequired()¶

Sets Subordinate Status to be required at a given value

param val

type val

int

rtype

None

UseFlagIgnored()¶

Sets Blank Status to be ignored (should not be defined, or its value should be 0)

rtype

None

UseFlagRequired()¶

Sets Blank Status to be required at a given value Give -1 to demand UseFlag not zero (but no precise value req.)

param val

type val

int

rtype

None

property thisown¶: The membership flag

class IGESData_DirPart(*args)¶

Bases: object

creates an empty DirPart, ready to be filled by Init

rtype

None

Init()¶

fills DirPart with consistant data read from file

param i1

type i1

int

param i2

type i2

int

param i3

type i3

int

param i4

type i4

int

param i5

type i5

int

param i6

type i6

int

param i7

type i7

int

param i8

type i8

int

param i9

type i9

int

param i19

type i19

int

param i11

type i11

int

param i12

type i12

int

param i13

type i13

int

param i14

type i14

int

param i15

type i15

int

param i16

type i16

int

param i17

type i17

int

param res1

type res1

char *

param res2

type res2

char *

param label

type label

char *

param subscript

type subscript

char *

rtype

None

Type()¶

returns ‘type’ and ‘form’ info, used to recognize the entity

rtype

IGESData_IGESType

Values()¶

returns values recorded in DirPart (content of cstrings are modified)

param i1

type i1

int

param i2

type i2

int

param i3

type i3

int

param i4

type i4

int

param i5

type i5

int

param i6

type i6

int

param i7

type i7

int

param i8

type i8

int

param i9

type i9

int

param i19

type i19

int

param i11

type i11

int

param i12

type i12

int

param i13

type i13

int

param i14

type i14

int

param i15

type i15

int

param i16

type i16

int

param i17

type i17

int

param res1

type res1

char *

param res2

type res2

char *

param label

type label

char *

param subscript

type subscript

char *

rtype

None

property thisown¶: The membership flag

class IGESData_FileProtocol(*args)¶

Bases: OCC.Core.IGESData.IGESData_Protocol

Returns an empty FileProtocol

rtype

None

Add()¶

Adds a resource

param protocol

type protocol

IGESData_Protocol

rtype

None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_FileRecognizer(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Add()¶

Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of callsHence, when Eval has failed to recognize, Evaluate will call Evaluate from the first added Recognizer if there is one, and to the second if there is still no result, and so on

param reco

type reco

IGESData_FileRecognizer

rtype

None

static DownCast(t)¶

Evaluate()¶

Evaluates if recognition has a result, returns it if yes In case of success, Returns True and puts result in ‘res’ In case of Failure, simply Returns False Works by calling deferred method Eval, and in case of failure, looks for Added Recognizers to work

param akey

type akey

IGESData_IGESType

param res

type res

IGESData_IGESEntity

rtype

bool

Result()¶

Returns result of last recognition (call of Evaluate)

rtype

opencascade::handle<IGESData_IGESEntity>

property thisown¶: The membership flag

class IGESData_FreeFormatEntity(*args)¶

Bases: OCC.Core.IGESData.IGESData_UndefinedEntity

Creates a completely empty FreeFormatEntity

rtype

None

AddEntities()¶

Adds a set of Entities, given as a HArray1OfIGESEntity Causes creation ofan Integer Parameter which gives count of Entities, then the list of Entities of the Array Error if an Entity is not an IGESEntity All these Entities will be interpreted as ‘Positive Pointers’ by IGESWriter

param ents

type ents

IGESData_HArray1OfIGESEntity

rtype

None

AddEntity()¶

Adds a Parameter which references an Entity. If the Entity is Null, the added parameter will define a ‘Null Pointer’ (0) If <negative> is given True, this will command Sending to File (see IGESWriter) to produce a ‘Negative Pointer’ (Default is False)

param ptype

type ptype

Interface_ParamType

param ent

type ent

IGESData_IGESEntity

param negative

default value is Standard_False

type negative

bool

rtype

None

AddLiteral()¶

Adds a literal Parameter to the list (as such)

param ptype

type ptype

Interface_ParamType

param val

type val

TCollection_HAsciiString

rtype

None* Adds a literal Parameter to the list (builds an HAsciiString)

param ptype

type ptype

Interface_ParamType

param val

type val

char *

rtype

None

AddNegativePointers()¶

Adds a list of Ranks of Parameters to be noted as Negative Pointers (this will be taken into account for Parameters which are Entities)

param list

type list

TColStd_HSequenceOfInteger

rtype

None

ClearNegativePointers()¶

Clears all informations about Negative Pointers, hence every Entity kind Parameter will be send normally, as Positive

rtype

None

static DownCast(t)¶

IsNegativePointer()¶

Returns True if <num> is noted as for a ‘Negative Pointer’ (see AddEntity for details). Senseful only if IsParamEntity answers True for <num>, else returns False.

param num

type num

int

rtype

bool

IsParamEntity()¶

Returns True if a Parameter is recorded as an entity Error if num is not between 1 and NbParams

param num

type num

int

rtype

bool

NbParams()¶

Gives count of recorded parameters

rtype

int

NegativePointers()¶

Returns the complete list of Ramks of Parameters which have been noted as Negative Pointers WarningIt is returned as a Null Handle if none was noted

rtype

opencascade::handle<TColStd_HSequenceOfInteger>

ParamData()¶

Returns data of a Parameterits type, and the entity if it designates en entity (‘ent’) or its literal value else (‘str’) Returned value (Boolean)True if it is an Entity, False else

param num

type num

int

param ptype

type ptype

Interface_ParamType

param ent

type ent

IGESData_IGESEntity

param val

type val

TCollection_HAsciiString

rtype

bool

ParamEntity()¶

Returns Entity corresponding to a Param, given its rank Error if out of range or if Param num does not designate an Entity

param num

type num

int

rtype

opencascade::handle<IGESData_IGESEntity>

ParamType()¶

Returns the ParamType of a Param, given its rank Error if num is not between 1 and NbParams

param num

type num

int

rtype

Interface_ParamType

ParamValue()¶

Returns litteral value of a Parameter, given its rank Error if num is out of range, or if Parameter is not literal

param num

type num

int

rtype

opencascade::handle<TCollection_HAsciiString>

SetFormNumber()¶

Sets Form Number to a new Value (to called after SetTypeNumber)

param formnum

type formnum

int

rtype

None

SetTypeNumber()¶

Sets Type Number to a new Value, and Form Number to Zero

param typenum

type typenum

int

rtype

None

property thisown¶: The membership flag

class IGESData_GeneralModule(*args, **kwargs)¶

Bases: OCC.Core.Interface.Interface_GeneralModule

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

DirChecker()¶

Returns a DirChecker, specific for each type of Entity (identified by its Case Number)this DirChecker defines constraints which must be respected by the DirectoryPart

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

rtype

IGESData_DirChecker

static DownCast(t)¶

OwnCheckCase()¶

Performs Specific Semantic Check for each type of Entity

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param shares

type shares

Interface_ShareTool

param ach

type ach

Interface_Check

rtype

void

OwnCopyCase()¶

Copies parameters which are specific of each Type of Entity

param CN

type CN

int

param entfrom

type entfrom

IGESData_IGESEntity

param entto

type entto

IGESData_IGESEntity

param TC

type TC

Interface_CopyTool

rtype

void

OwnDeleteCase()¶

Specific preparation for delete, acts on own parameters Default does nothing, to be redefined as required

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

rtype

void

OwnImpliedCase()¶

Specific list of Entities implied by a given IGESEntity <ent> (in addition to Associativities). By default, there are none, but this method can be redefined as required

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param iter

type iter

Interface_EntityIterator

rtype

void

OwnRenewCase()¶

Renews parameters which are specific of each Type of Entitythe provided default does nothing, but this method may be redefined as required

param CN

type CN

int

param entfrom

type entfrom

IGESData_IGESEntity

param entto

type entto

IGESData_IGESEntity

param TC

type TC

Interface_CopyTool

rtype

void

OwnSharedCase()¶

Lists the Entities shared by a given IGESEntity <ent>, from its specific parametersspecific for each type

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param iter

type iter

Interface_EntityIterator

rtype

void

property thisown¶: The membership flag

class IGESData_GlobalNodeOfSpecificLib(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates an empty GlobalNode, with no Next

rtype

None

Add()¶

Adds a Module bound with a Protocol to the listdoes nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondance

param amodule

type amodule

IGESData_SpecificModule

param aprotocol

type aprotocol

IGESData_Protocol

rtype

None

static DownCast(t)¶

Module()¶

Returns the Module stored in a given GlobalNode

rtype

opencascade::handle<IGESData_SpecificModule>

Next()¶

Returns the Next GlobalNode. If none is defined, returned value is a Null Handle

rtype

opencascade::handle<IGESData_GlobalNodeOfSpecificLib>

Protocol()¶

Returns the attached Protocol stored in a given GlobalNode

rtype

opencascade::handle<IGESData_Protocol>

property thisown¶: The membership flag

class IGESData_GlobalNodeOfWriterLib(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates an empty GlobalNode, with no Next

rtype

None

Add()¶

Adds a Module bound with a Protocol to the listdoes nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondance

param amodule

type amodule

IGESData_ReadWriteModule

param aprotocol

type aprotocol

IGESData_Protocol

rtype

None

static DownCast(t)¶

Module()¶

Returns the Module stored in a given GlobalNode

rtype

opencascade::handle<IGESData_ReadWriteModule>

Next()¶

Returns the Next GlobalNode. If none is defined, returned value is a Null Handle

rtype

opencascade::handle<IGESData_GlobalNodeOfWriterLib>

Protocol()¶

Returns the attached Protocol stored in a given GlobalNode

rtype

opencascade::handle<IGESData_Protocol>

property thisown¶: The membership flag

class IGESData_GlobalSection(*args)¶

Bases: object

Creates an empty GlobalSection, ready to be filled, WarningNo default value is provided

rtype

None

ApplicationProtocol()¶

Return type: opencascade::handle<TCollection_HAsciiString>

AuthorName()¶

Returns the name of the IGES file author.

rtype

opencascade::handle<TCollection_HAsciiString>

CompanyName()¶

Returns the name of the company where the IGES file was written.

rtype

opencascade::handle<TCollection_HAsciiString>

CopyRefs()¶

Copies data referenced by Handle (that is, Strings) usefull to ‘isolate’ a GlobalSection after copy by ‘=’ (from a Model to another Model for instance)

rtype

None

Date()¶

Returns the IGES file creation date.

rtype

opencascade::handle<TCollection_HAsciiString>

DraftingStandard()¶

Return type: int

EndMark()¶

Returns the record delimiter character.

rtype

Standard_Character

FileName()¶

Returns the name of the IGES file.

rtype

opencascade::handle<TCollection_HAsciiString>

HasApplicationProtocol()¶

Return type: bool

HasLastChangeDate()¶

Returns True if the date and time when the model was created or last modified are specified, i.e. not defaulted to NULL.

rtype

bool

HasMaxCoord()¶

Returns True if the approximate maximum coordinate value found in the model is greater than 0.

rtype

bool

IGESVersion()¶

Returns the IGES version that the IGES file was written in.

rtype

int

Init()¶

Fills GlobalSection from a ParamSet (i.e. taken from file) undefined parameters do not change default values when defined Fills Check about Corrections or Fails

param params

type params

Interface_ParamSet

param ach

type ach

Interface_Check

rtype

None

IntegerBits()¶

Returns the number of binary bits for integer representations.

rtype

int

InterfaceVersion()¶

Returns the name of the pre-processor used to write the IGES file.

rtype

opencascade::handle<TCollection_HAsciiString>

LastChangeDate()¶

Returns the date and time when the model was created or last modified (for IGES 5.1 and later).

rtype

opencascade::handle<TCollection_HAsciiString>

LineWeightGrad()¶

Returns the maximum number of line weight gradations.

rtype

int

MaxCoord()¶

Returns the approximate maximum coordinate value found in the model.

rtype

float

MaxDigitsDouble()¶

Return type: int

MaxDigitsSingle()¶

Return type: int

MaxLineWeight()¶

Returns the of maximum line weight width in IGES file units.

rtype

float

MaxMaxCoord()¶

Parameters: val – default value is 0.0 :type val: float :rtype: None

MaxMaxCoords()¶

Parameters

xyz –

type xyz: gp_XYZ
rtype: None

MaxPower10Double()¶

Returns the maximum power of a decimal representation of a double-precision floating point number in the sending system.

rtype

int

MaxPower10Single()¶

Returns the maximum power of a decimal representation of a single-precision floating point number in the sending system.

rtype

int

static NewDateString()¶

Returns a string built from year, month, day, hour, minute and second values. The form of the resulting string is defined as follows: - -1: YYMMDD.HHNNSS, - 0: YYYYMMDD.HHNNSS, - 1: YYYY-MM-DD:HH-NN-SS, where: - YYYY or YY is 4 or 2 digit year, - HH is hour (00-23), - MM is month (01-12), - NN is minute (00-59) - DD is day (01-31), - SS is second (00-59).

param year

type year

int

param month

type month

int

param day

type day

int

param hour

type hour

int

param minut

type minut

int

param second

type second

int

param mode

default value is -1

type mode

int

rtype

opencascade::handle<TCollection_HAsciiString>* Converts the string given in the form YYMMDD.HHNNSS or YYYYMMDD.HHNNSS to either YYMMDD.HHNNSS, YYYYMMDD.HHNNSS or YYYY-MM-DD:HH-NN-SS.

param date

type date

TCollection_HAsciiString

param mode

default value is 1

type mode

int

rtype

opencascade::handle<TCollection_HAsciiString>

Params()¶

Returns all contained data in the form of a ParamSet RemarkStrings are given under Hollerith form

rtype

opencascade::handle<Interface_ParamSet>

ReceiveName()¶

Returns the name of the receiving system.

rtype

opencascade::handle<TCollection_HAsciiString>

Resolution()¶

Returns the resolution used in the IGES file.

rtype

float

Scale()¶

Returns the scale used in the IGES file.

rtype

float

SendName()¶

Returns the name of the sending system.

rtype

opencascade::handle<TCollection_HAsciiString>

Separator()¶

Returns the parameter delimiter character.

rtype

Standard_Character

SetApplicationProtocol()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetAuthorName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetCompanyName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetDate()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetDraftingStandard()¶

Parameters

val –

type val: int
rtype: None

SetEndMark()¶

Parameters

val –

type val: Standard_Character
rtype: None

SetFileName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetIGESVersion()¶

Parameters

val –

type val: int
rtype: None

SetIntegerBits()¶

Parameters

val –

type val: int
rtype: None

SetInterfaceVersion()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetLastChangeDate()¶

Return type: None:param val: :type val: TCollection_HAsciiString :rtype: None

SetLineWeightGrad()¶

Parameters

val –

type val: int
rtype: None

SetMaxCoord()¶

Parameters: val – default value is 0.0 :type val: float :rtype: None

SetMaxDigitsDouble()¶

Parameters

val –

type val: int
rtype: None

SetMaxDigitsSingle()¶

Parameters

val –

type val: int
rtype: None

SetMaxLineWeight()¶

Parameters

val –

type val: float
rtype: None

SetMaxPower10Double()¶

Parameters

val –

type val: int
rtype: None

SetMaxPower10Single()¶

Parameters

val –

type val: int
rtype: None

SetReceiveName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetResolution()¶

Parameters

val –

type val: float
rtype: None

SetScale()¶

Parameters

val –

type val: float
rtype: None

SetSendName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetSeparator()¶

Parameters

val –

type val: Standard_Character
rtype: None

SetSystemId()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SetUnitFlag()¶

Parameters

val –

type val: int
rtype: None

SetUnitName()¶

Parameters

val –

type val: TCollection_HAsciiString
rtype: None

SystemId()¶

Returns the Native System ID of the system that created the IGES file.

rtype

opencascade::handle<TCollection_HAsciiString>

TranslatedFromHollerith()¶

Returns a string withpout its Hollerith marks (nnnH ahead). Remarkall strings stored in GlobalSection are expurged from Hollerith informations (without nnnH) If <astr> is not Hollerith form, it is simply copied

param astr

type astr

TCollection_HAsciiString

rtype

opencascade::handle<TCollection_HAsciiString>

UnitFlag()¶

Returns the unit flag that was used to write the IGES file.

rtype

int

UnitName()¶

Returns the name of the unit the IGES file was written in.

rtype

opencascade::handle<TCollection_HAsciiString>

UnitValue()¶

Returns the unit value (in meters) that the IGES file was written in.

rtype

float

property thisown¶: The membership flag

class IGESData_HArray1OfIGESEntity(*args)¶

Bases: OCC.Core.IGESData.IGESData_Array1OfIGESEntity, OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Array1()¶

ChangeArray1()¶

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_IGESDumper(*args)¶

Bases: object

Returns an IGESDumper ready to work. The IGESModel provides the numbering of Entitiesas for any InterfaceModel, it gives each Entity a number; but for IGESEntities, the ‘Number of Directory Entry’ according to the definition of IGES Files, is also usefull

param model

type model

IGESData_IGESModel

param protocol

type protocol

IGESData_Protocol

rtype

None

Dump()¶

Parameters

ent –

type ent: IGESData_IGESEntity
param S
type S: Message_Messenger
param own
type own: int
param attached: default value is -1
type attached: int
rtype: None

OwnDump()¶

Specific Dump for each IGES Entity, call by Dump (just above) <own> is the parameter <own> from Dump

param ent

type ent

IGESData_IGESEntity

param S

type S

Message_Messenger

param own

type own

int

rtype

None

PrintDNum()¶

Prints onto an output, the ‘Number of Directory Entry’ which corresponds to an IGESEntity in the IGESModel, under the form ‘D#nnn’ (a Null Handle gives D#0)

param ent

type ent

IGESData_IGESEntity

param S

type S

Message_Messenger

rtype

None

PrintShort()¶

Prints onto an output, the ‘Number of Directory Entry’ (see PrintDNum) plus IGES Type and Form Numbers, which gives ‘D#nnn Type nnn Form nnn’

param ent

type ent

IGESData_IGESEntity

param S

type S

Message_Messenger

rtype

None

property thisown¶: The membership flag

class IGESData_IGESEntity(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

AddProperty()¶

Adds a Property in the list

param ent

type ent

IGESData_IGESEntity

rtype

None

ArePresentAssociativities()¶

Returns True if the Entity is defined with an Associativity list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list.

rtype

bool

ArePresentProperties()¶

Returns True if the Entity is defined with a Property list, even empty (that is, file contains its length 0) Else, the file contained NO idencation at all about this list

rtype

bool

Associate()¶

Sets ‘me’ in the Associativity list of another Entity

param ent

type ent

IGESData_IGESEntity

rtype

None

Associativities()¶

Returns the Associativity List under the form of an EntityIterator.

rtype

Interface_EntityIterator

BlankStatus()¶

gives Blank Status (0 visible, 1 blanked)

rtype

int

CResValues()¶

returns ‘reserved’ alphanumeric values res1 and res2 res1 and res2 have to be reserved as Character[9 at least] (remarktheir content is changed) returned values are ended by null character in 9th returned Boolean is False if res1 and res2 are blank, true else

param res1

type res1

char *

param res2

type res2

char *

rtype

bool

Color()¶

Returns the IGES entity which describes the color of the entity. Returns a null handle if this entity was defined as an integer.

rtype

opencascade::handle<IGESData_ColorEntity>

CompoundLocation()¶

Returns Location by taking in account a Parent which has its own Locationthat one will be combined to that of <self> The Parent is considered only if HasOneParent is True, else it is ignored and CompoundLocation = Location

rtype

gp_GTrsf

DefColor()¶

Returns the definition status of Color.

rtype

IGESData_DefType

DefLevel()¶

Returns the definition status of Level

rtype

IGESData_DefList

DefLineFont()¶

Returns the definition status of LineFont

rtype

IGESData_DefType

DefView()¶

Returns the definition status of the view. This can be: none, one or several.

rtype

IGESData_DefList

DirFieldEntity()¶

Returns the Entity which has been recorded for a given Field Number, i.e. without any cast. Maps with3Structure 4LineFont 5LevelList 6View 7Transf(ormation Matrix) 8LabelDisplay 13Color. Other values give a null handle It can then be of any kind, while specific items have a Type

param fieldnum

type fieldnum

int

rtype

opencascade::handle<IGESData_IGESEntity>

Dissociate()¶

Resets ‘me’ from the Associativity list of another Entity

param ent

type ent

IGESData_IGESEntity

rtype

None

static DownCast(t)¶

FormNumber()¶

Returns the form number for that type of an IGES entity. The default form number is 0.

rtype

int

HasLabelDisplay()¶

Returns True if a LabelDisplay mode is defined for this entity

rtype

bool

HasName()¶

says if a Name is defined, as Short Label or as Name Property (Property is looked first, else ShortLabel is considered)

rtype

bool

HasOneParent()¶

Returns True if an entity has one and only one parent, defined by a SingleParentEntity Type Associativity (explicit sharing). Thus, implicit sharing remains defined at model level (see class ToolLocation)

rtype

bool

HasShortLabel()¶

Returns true if a short label is defined. A short label is a non-blank 8-character string.

rtype

bool

HasStructure()¶

returns True if an IGESEntity is defined with a Structure (it is normally reserved for certain classes, such as Macros)

rtype

bool

HasSubScriptNumber()¶

Returns true if a subscript number is defined. A subscript number is an integer used to identify a label.

rtype

bool

HasTransf()¶

Returns True if a Transformation Matrix is defined

rtype

bool

HierarchyStatus()¶

gives Hierarchy status (0-1-2)

rtype

int

IGESType()¶

gives IGES typing info (includes ‘Type’ and ‘Form’ data)

rtype

IGESData_IGESType

InitColor()¶

Initializes Color dataif <ent> is not Null, it gives Color, else <rank> gives or erases (if zero) RankColor

param ent

type ent

IGESData_ColorEntity

param rank

default value is 0

type rank

int

rtype

None

InitDirFieldEntity()¶

Initializes a directory field as an Entiy of any kind See DirFieldEntity for more details

param fieldnum

type fieldnum

int

param ent

type ent

IGESData_IGESEntity

rtype

None

InitLevel()¶

Initializes Levelif <ent> is not Null, it gives LevelList, else <val> gives or erases (if zero) unique Level

param ent

type ent

IGESData_LevelListEntity

param val

default value is 0

type val

int

rtype

None

InitLineFont()¶

Initializes LineFontif <ent> is not Null, it gives LineFont, else <rank> gives or erases (if zero) RankLineFont

param ent

type ent

IGESData_LineFontEntity

param rank

default value is 0

type rank

int

rtype

None

InitMisc()¶

Initializes various data (those not yet seen above), or erases them if they are given as Null (Zero for <weightnum>)<str> for Structure, <lab> for LabelDisplay, and <weightnum> for WeightNumber

param str

type str

IGESData_IGESEntity

param lab

type lab

IGESData_LabelDisplayEntity

param weightnum

type weightnum

int

rtype

None

InitStatus()¶

Initializes the Status of Directory Part

param blank

type blank

int

param subordinate

type subordinate

int

param useflag

type useflag

int

param hierarchy

type hierarchy

int

rtype

None

InitTransf()¶

Initializes Transf, or erases it if <ent> is given Null

param ent

type ent

IGESData_TransfEntity

rtype

None

InitView()¶

Initializes View, or erases it if <ent> is given Null

param ent

type ent

IGESData_ViewKindEntity

rtype

None

LabelDisplay()¶

Returns the Label Display Associativity Entity if there is one. Returns a null handle if there is none.

rtype

opencascade::handle<IGESData_LabelDisplayEntity>

Level()¶

Returns the level the entity belongs to. Returns -1 if the entity belongs to more than one level.

rtype

int

LevelList()¶

Returns LevelList if Level is defined as a list. Returns a null handle if DefLevel is not DefSeveral.

rtype

opencascade::handle<IGESData_LevelListEntity>

LineFont()¶

Returns LineFont as an Entity (if defined as Reference) Returns a Null Handle if DefLineFont is not ‘DefReference’

rtype

opencascade::handle<IGESData_LineFontEntity>

LineWeight()¶

Returns the true Line Weight, computed from LineWeightNumber and Global Parameter in the Model by call to SetLineWeight

rtype

float

LineWeightNumber()¶

Returns the LineWeight Number (0 not defined), see also LineWeight

rtype

int

Location()¶

Returns Location given by Transf in Directory Part (see above) It must be considered for local definitionif the Entity is set in a ‘Parent’, that one can add its one Location, but this is not taken in account heresee CompoundLocation for that. If no Transf is defined, returns Identity If Transf is itself compound, gives the final result

rtype

gp_GTrsf

NameValue()¶

returns Name value as a String (Property Name or ShortLabel) if SubNumber is defined, it is concatenated after ShortLabel as follows label(number). Ignored with a Property Name

rtype

opencascade::handle<TCollection_HAsciiString>

NbAssociativities()¶

gives number of recorded associativities (0 no list defined)

rtype

int

NbProperties()¶

Gives number of recorded properties (0 no list defined)

rtype

int

NbTypedAssociativities()¶

gives how many Associativities have a given type

param atype

type atype

Standard_Type

rtype

int

NbTypedProperties()¶

gives how many Properties have a given type

param atype

type atype

Standard_Type

rtype

int

Properties()¶

Returns Property List under the form of an EntityIterator

rtype

Interface_EntityIterator

RankColor()¶

Returns the color definition as an integer value if the color was defined as a rank. Warning A negative value is returned if the color was defined as an entity.

rtype

int

RankLineFont()¶

Returns LineFont definition as an Integer (if defined as Rank) If LineFont is defined as an Entity, returns a negative value

rtype

int

RemoveProperty()¶

Removes a Property from the list

param ent

type ent

IGESData_IGESEntity

rtype

None

SetLabel()¶

Sets a new Label to an IGES Entity If <sub> is given, it sets value of SubScriptNumber else, SubScriptNumber is erased

param label

type label

TCollection_HAsciiString

param sub

default value is -1

type sub

int

rtype

None

SetLineWeight()¶

computes and sets ‘true’ line weight according IGES rules from global data MaxLineWeight (maxv) and LineWeightGrad (gradw), or sets it to defw (Default) if LineWeightNumber is null

param defw

type defw

float

param maxw

type maxw

float

param gradw

type gradw

int

rtype

None

ShortLabel()¶

Returns the label value for this IGES entity as a string. Warning If the label is blank, this string is null.

rtype

opencascade::handle<TCollection_HAsciiString>

SingleView()¶

Returns the view as a single view if it was defined as such and not as a list of views. Warning A null handle is returned if DefView does not have the value DefOne.

rtype

opencascade::handle<IGESData_ViewKindEntity>

Structure()¶

Returns Structure (used by some types of IGES Entities only) Returns a Null Handle if Structure is not defined

rtype

opencascade::handle<IGESData_IGESEntity>

SubScriptNumber()¶

Returns the integer subscript number used to identify this IGES entity. Warning 0 is returned if no subscript number is defined for this IGES entity.

rtype

int

SubordinateStatus()¶

gives Subordinate Switch (0-1-2-3)

rtype

int

Transf()¶

Returns the Transformation Matrix (under IGES definition) Returns a Null Handle if there is none for a more complete use, see Location & CompoundLocation

rtype

opencascade::handle<IGESData_TransfEntity>

TypeNumber()¶

gives IGES Type Number (often coupled with Form Number)

rtype

int

TypedAssociativity()¶

returns the Associativity of a given Type (if only one exists) Error if none or more than one

param atype

type atype

Standard_Type

rtype

opencascade::handle<IGESData_IGESEntity>

TypedProperty()¶

returns the Property of a given Type Error if none or more than one

param atype

type atype

Standard_Type

param anum

default value is 0

type anum

int

rtype

opencascade::handle<IGESData_IGESEntity>

UniqueParent()¶

Returns the Unique Parent (in the sense given by HasOneParent) Error if there is none or several

rtype

opencascade::handle<IGESData_IGESEntity>

UseFlag()¶

gives Entity’s Use Flag (0 to 5)

rtype

int

VectorLocation()¶

Returns Location considered for Vectors, i.e. without its Translation Part. As Location, it gives local definition.

rtype

gp_GTrsf

View()¶

Returns the view of this IGES entity. This view can be a single view or a list of views. Warning A null handle is returned if the view is not defined.

rtype

opencascade::handle<IGESData_ViewKindEntity>

ViewList()¶

Returns the view of this IGES entity as a list. Warning A null handle is returned if the definition status does not have the value DefSeveral.

rtype

opencascade::handle<IGESData_ViewKindEntity>

property thisown¶: The membership flag

class IGESData_IGESModel(*args)¶

Bases: OCC.Core.Interface.Interface_InterfaceModel

Return type: None

AddStartLine()¶

Adds a new string to the existing Start section at the end if atnum is 0 or not given, or before atnumth line.

param line

type line

char *

param atnum

default value is 0

type atnum

int

rtype

None

ApplyStatic()¶

Sets some of the Global section parameters with the values defined by the translation parameters. param may be: - receiver (value read in XSTEP.iges.header.receiver), - author (value read in XSTEP.iges.header.author), - company (value read in XSTEP.iges.header.company). The default value for param is an empty string. Returns True when done and if param is given, False if param is unknown or empty. Note: Set the unit in the IGES file Global section via IGESData_BasicEditor class.

param param

default value is

type param

char *

rtype

bool

ClearStartSection()¶

Clears the IGES file Start Section

rtype

None

DNum()¶

Returns the equivalent DE Number for an Entity, i.e. 2*Number(ent)-1 , or 0 if <ent> is unknown from <self> This DE Number is used for File Writing for instance

param ent

type ent

IGESData_IGESEntity

rtype

int

static DownCast(t)¶

Entity()¶

Returns an IGES entity given by its rank number.

param num

type num

int

rtype

opencascade::handle<IGESData_IGESEntity>

GlobalSection()¶

Returns the Global section of the IGES file.

rtype

IGESData_GlobalSection

NbStartLines()¶

Returns the count of recorded Start Lines

rtype

int

PrintInfo()¶

Prints label specific to IGES norm for a given entity, i.e. its directory entry number (2*Number-1)

param ent

type ent

Standard_Transient

param S

type S

Message_Messenger

rtype

None

SetGlobalSection()¶

Sets the Global section of the IGES file.

param header

type header

IGESData_GlobalSection

rtype

None

SetLineWeights()¶

Sets LineWeights of contained Entities according header data (MaxLineWeight and LineWeightGrad) or to a default value for undefined weights

param defw

type defw

float

rtype

None

SetStartSection()¶

Sets a new Start section from a list of strings. If copy is false, the Start section will be shared. Any modifications made to the strings later on, will have an effect on the Start section. If copy is true (default value), an independent copy of the strings is created and used as the Start section. Any modifications made to the strings later on, will have no effect on the Start section.

param list

type list

TColStd_HSequenceOfHAsciiString

param copy

default value is Standard_True

type copy

bool

rtype

None

StartLine()¶

Returns a line from the IGES file Start section by specifying its number. An empty string is returned if the number given is out of range, the range being from 1 to NbStartLines.

param num

type num

int

rtype

char *

StartSection()¶

Returns Model’s Start Section (list of comment lines)

rtype

opencascade::handle<TColStd_HSequenceOfHAsciiString>

property thisown¶: The membership flag

class IGESData_IGESReaderData(*args)¶

Bases: OCC.Core.Interface.Interface_FileReaderData

creates IGESReaderData correctly dimensionned (for arrays) <nbe> count of entities, that is, half nb of directory lines <nbp>count of parameters

param nbe

type nbe

int

param nbp

type nbp

int

rtype

None

AddGlobal()¶

adds a parameter to global section’s parameter list

param atype

type atype

Interface_ParamType

param aval

type aval

char *

rtype

None

AddStartLine()¶

adds a start line to start section

param aval

type aval

char *

rtype

None

DefaultLineWeight()¶

Returns the recorded Default Line Weight, if there is (else, returns 0)

rtype

float

DirPart()¶

returns DirPart identified by record no (half Dsect number)

param num

type num

int

rtype

IGESData_DirPart

DirType()¶

returns ‘type’ and ‘form’ info from a directory part

param num

type num

int

rtype

IGESData_IGESType

DirValues()¶

returns values recorded in directory part n0 <num>

param num

type num

int

param i1

type i1

int

param i2

type i2

int

param i3

type i3

int

param i4

type i4

int

param i5

type i5

int

param i6

type i6

int

param i7

type i7

int

param i8

type i8

int

param i9

type i9

int

param i10

type i10

int

param i11

type i11

int

param i12

type i12

int

param i13

type i13

int

param i14

type i14

int

param i15

type i15

int

param i16

type i16

int

param i17

type i17

int

param res1

type res1

char *

param res2

type res2

char *

param label

type label

char *

param subs

type subs

char *

rtype

None

static DownCast(t)¶

GlobalCheck()¶

Returns the recorded Global Check

rtype

opencascade::handle<Interface_Check>

GlobalSection()¶

returns header as GlobalSection

rtype

IGESData_GlobalSection

SetDefaultLineWeight()¶

allows to set a default line weight, will be later applied at load time, on Entities which have no specified line weight

param defw

type defw

float

rtype

None

SetDirPart()¶

fills a DirPart, designated by its rank (that is, (N+1)/2 if N is its first number in section D)

param num

type num

int

param i1

type i1

int

param i2

type i2

int

param i3

type i3

int

param i4

type i4

int

param i5

type i5

int

param i6

type i6

int

param i7

type i7

int

param i8

type i8

int

param i9

type i9

int

param i10

type i10

int

param i11

type i11

int

param i12

type i12

int

param i13

type i13

int

param i14

type i14

int

param i15

type i15

int

param i16

type i16

int

param i17

type i17

int

param res1

type res1

char *

param res2

type res2

char *

param label

type label

char *

param subs

type subs

char *

rtype

None

SetEntityNumbers()¶

determines reference numbers in EntityNumber fields (called by SetEntities from IGESReaderTool) works on ‘Integer’ type Parameters, because IGES does not distinguish Integer and Entity Refsevery Integer which is odd and less than twice NbRecords can be an Entity Ref … (Ref Number is then (N+1)/2 if N is the Integer Value)

rtype

None

SetGlobalSection()¶

reads header (as GlobalSection) content from the ParamSet after it has been filled by successive calls to AddGlobal

rtype

None

StartSection()¶

Returns the Start Section in once

rtype

opencascade::handle<TColStd_HSequenceOfHAsciiString>

property thisown¶: The membership flag

class IGESData_IGESReaderTool(*args)¶

Bases: OCC.Core.Interface.Interface_FileReaderTool

creates IGESReaderTool to work with an IGESReaderData and an IGES Protocol. Actually, no Lib is used

param reader

type reader

IGESData_IGESReaderData

param protocol

type protocol

IGESData_Protocol

rtype

None

Prepare()¶

binds empty entities to records, works with the Protocol (from IGESData) stored and later used RQActually, sets DNum into IGES Entities Also loads the list of parameters for ParamReader

param reco

type reco

IGESData_FileRecognizer

rtype

None

ReadAssocs()¶

Reads Associativity List, if there is (if not, does nothing) criterium iscurrent parameter of PR remains inside params list, and Stage is ‘Own’ Same conditions as above; in addition, no parameter must be let after the list once read Note that ‘Associated’ entities are not declared ‘Shared’

param ent

type ent

IGESData_IGESEntity

param IR

type IR

IGESData_IGESReaderData

param PR

type PR

IGESData_ParamReader

rtype

None

ReadDir()¶

Reads directory part componants from file; DP is the litteral directory part, IR detains entities referenced by DP

param ent

type ent

IGESData_IGESEntity

param IR

type IR

IGESData_IGESReaderData

param DP

type DP

IGESData_DirPart

param ach

type ach

Interface_Check

rtype

None

ReadOwnParams()¶

Performs Reading of own Parameters for each IGESEntity Works with the ReaderLib loaded with ReadWriteModules for IGES In case of failure, tries UndefinedEntity from IGES

param ent

type ent

IGESData_IGESEntity

param IR

type IR

IGESData_IGESReaderData

param PR

type PR

IGESData_ParamReader

rtype

None

ReadProps()¶

Reads Property List, if there is (if not, does nothing) criterium iscurrent parameter of PR remains inside params list, and Stage is ‘Own’ Current parameter must be a positive integer, which value gives the length of the list; else, a Fail is produced (into Check of PR) and reading process is stopped

param ent

type ent

IGESData_IGESEntity

param IR

type IR

IGESData_IGESReaderData

param PR

type PR

IGESData_ParamReader

rtype

None

property thisown¶: The membership flag

class IGESData_IGESType(*args)¶

Bases: object

Return type: None:param atype: :type atype: int :param aform: :type aform: int :rtype: None

Form()¶

returns ‘form’ data

rtype

int

IsEqual()¶

compares two IGESTypes, avoiding comparing their fields

param another

type another

IGESData_IGESType

rtype

bool

Nullify()¶

resets fields (usefull when an IGESType is stored as mask)

rtype

None

Type()¶

returns ‘type’ data

rtype

int

property thisown¶: The membership flag

class IGESData_IGESWriter(*args)¶

Bases: object

Creates an IGESWriter, empty ready to work (see the methods SendModel and Print)

param amodel

type amodel

IGESData_IGESModel

rtype

None* Default constructor (not used) to satisfy the compiler

rtype

None* Constructor by copy (not used) to satisfy the compiler

param other

type other

IGESData_IGESWriter

rtype

None

Associativities()¶

sends associativity list, as complement of parameters list error if not in sections DP or Stage not ‘Associativity’

param anent

type anent

IGESData_IGESEntity

rtype

None

DirPart()¶

translates directory part of an Entity into a litteral DirPart Some infos are computed after sending parameters Error if not in sections DP or Stage not ‘Dir’

param anent

type anent

IGESData_IGESEntity

rtype

None

EndEntity()¶

declares end of sending an entity (ends param list by ‘;’)

rtype

None

FloatWriter()¶

Returns the embedded FloatWriter, which controls sending Reals Use this method to access FloatWriter in order to consult or change its options (MainFormat, FormatForRange,ZeroSuppress), because it is returned as the address of its field

rtype

Interface_FloatWriter

GetWriteMode(IGESData_IGESWriter self) → Standard_Integer¶

OwnParams()¶

sends own parameters of the entity, by sending firstly its type, then calling specific method WriteOwnParams Error if not in sections DP or Stage not ‘Own’

param anent

type anent

IGESData_IGESEntity

rtype

None

PrintToString(IGESData_IGESWriter self) → std::string¶

Properties()¶

sends property list, as complement of parameters list error if not in sections DP or Stage not ‘Property’

param anent

type anent

IGESData_IGESEntity

rtype

None

SectionG()¶

prepares sending of header, from a GlobalSection (stores it) error if SectionS was not called just before takes in account special characters (Separator, EndMark)

param header

type header

IGESData_GlobalSection

rtype

None

SectionS()¶

declares sending of S section (only a declaration) error if state is not initial

rtype

None

SectionStrings()¶

Returns the list of strings for a section given its rank 1Start (if not empty) 2Global 3 or 4Parameters RQ: no string list for Directory section An empty section gives a null handle

param numsec

type numsec

int

rtype

opencascade::handle<TColStd_HSequenceOfHAsciiString>

SectionT()¶

declares sending of T section (only a declaration) error if does not follow Entities sending

rtype

None

SectionsDP()¶

prepares sending of list of entities, as Sections D (directory list) and P (Parameters lists, one per entity) Entities will be then processed, one after the other error if SectionG has not be called just before

rtype

None

SendBoolean()¶

sends a Boolean parameter as an Integer value 0(False)/1(True)

param val

type val

bool

rtype

None

SendModel()¶

Sends the complete IGESModel (Global Section, Entities as Directory Entries & Parameter Lists, etc…) i.e. fills a list of texts. Once filled, it can be sent by method Print

param protocol

type protocol

IGESData_Protocol

rtype

None

SendStartLine()¶

Sends an additionnal Starting Linethis is the way used to send comments in an IGES File (at beginning of the file). If the line is more than 72 char.s long, it is splited into as many lines as required to send it completely

param startline

type startline

char *

rtype

None

SendString()¶

sends a parameter under its exact form given as a string

param val

type val

TCollection_HAsciiString

rtype

None

SendVoid()¶

sends a void parameter, that is null text

rtype

None

SetWriteMode(IGESData_IGESWriter self, Standard_Integer value)¶

property thisown¶: The membership flag

class IGESData_LabelDisplayEntity¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_LevelListEntity(*args, **kwargs)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

HasLevelNumber()¶

returns True if <level> is in the list

param level

type level

int

rtype

bool

LevelNumber()¶

returns the Level Number of <self>, indicated by <num> raises an exception if num is out of range

param num

type num

int

rtype

int

NbLevelNumbers()¶

Must return the count of levels

rtype

int

property thisown¶: The membership flag

class IGESData_LineFontEntity¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_NameEntity(*args, **kwargs)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

Value()¶

Retyrns the alphanumeric value of the Name, to be defined

rtype

opencascade::handle<TCollection_HAsciiString>

property thisown¶: The membership flag

class IGESData_NodeOfSpecificLib(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates an empty Node, with no Next

rtype

None

AddNode()¶

Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it

param anode

type anode

IGESData_GlobalNodeOfSpecificLib

rtype

None

static DownCast(t)¶

Module()¶

Returns the Module designated by a precise Node

rtype

opencascade::handle<IGESData_SpecificModule>

Next()¶

Returns the Next Node. If none was defined, returned value is a Null Handle

rtype

opencascade::handle<IGESData_NodeOfSpecificLib>

Protocol()¶

Returns the Protocol designated by a precise Node

rtype

opencascade::handle<IGESData_Protocol>

property thisown¶: The membership flag

class IGESData_NodeOfWriterLib(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates an empty Node, with no Next

rtype

None

AddNode()¶

Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it

param anode

type anode

IGESData_GlobalNodeOfWriterLib

rtype

None

static DownCast(t)¶

Module()¶

Returns the Module designated by a precise Node

rtype

opencascade::handle<IGESData_ReadWriteModule>

Next()¶

Returns the Next Node. If none was defined, returned value is a Null Handle

rtype

opencascade::handle<IGESData_NodeOfWriterLib>

Protocol()¶

Returns the Protocol designated by a precise Node

rtype

opencascade::handle<IGESData_Protocol>

property thisown¶: The membership flag

class IGESData_ParamCursor(*args)¶

Bases: object

Creates a Cursor to read a precise parameter of ParamReader, identified by its number, then set Current Number to ‘num + 1’ (this constructor allows to simply give a Number to a method Read… from ParamReader, which will be translated into a ParamCursor by compiler)

param num

type num

int

rtype

None* Creates a Cursor to read a list of parameters (count ‘nb’) starting from a precise one (number ‘num’) included, then set Current Number of ParamNumber to the first following one (‘num + nb’) If size is given, it means that each parameter is made of more than one term. One term is the normal (default) case : for instance, a Parameter comprises one Integer, or one Entity … Size gives the complete size of each Item if it is complex. To be used ONLY IF it is constant

param num

type num

int

param nb

type nb

int

param size

default value is 1

type size

int

rtype

None

Advance()¶

Returns True if Advance command has been set

rtype

bool

Count()¶

Returns required count of items to be read

rtype

int

ItemSize()¶

Returns length of item (count of parameters per item)

rtype

int

Limit()¶

Returns (excluded) upper limit number for reading parameters

rtype

int

Offset()¶

Returns offset from which current term must be read in item

rtype

int

SetAdvance()¶

Changes command to advance current cursor after reading parameters. If ‘advance’ True, sets advance, if ‘False’, resets it. ParamCursor is created by default with True.

param advance

type advance

bool

rtype

None

SetOne()¶

Defines a term of one Parameter (very current case)

param autoadv

default value is Standard_True

type autoadv

bool

rtype

None

SetTerm()¶

Defines the size of a term to read in the itemthis commands ParamReader to read ‘size’ parameters for each item, then skip the remainder of the item to the same term of next Item (that is, skip ‘item size’ - ‘term size’) //! In addition, Offset from beginning of Item is managedAfter being created, and for the frist call to SetTerm, the part of Item to be read begins exactly as the Item begins But after a SetTerm, the next read will add an offset which is the size of former term. //! autoadv commands Advance management. If it is True (default), the last SetTerm (Item size has been covered) calls SetAdvance If it is False, SetAdvance must be called directly if necessary //! Error if a SetTerm overpasses the size of the Item

param size

type size

int

param autoadv

default value is Standard_True

type autoadv

bool

rtype

None

SetXY()¶

Defines a term of two Parameters for a XY (current case)

param autoadv

default value is Standard_True

type autoadv

bool

rtype

None

SetXYZ()¶

Defines a term of three Parameters for XYZ (current case)

param autoadv

default value is Standard_True

type autoadv

bool

rtype

None

Start()¶

Returns (included) starting number for reading parameters

rtype

int

TermSize()¶

Returns length of current term (count of parameters) in item

rtype

int

property thisown¶: The membership flag

class IGESData_ParamReader(*args)¶

Bases: object

Prepares a ParamReader, stage ‘Own’, current param = 1 It considers a part of the list, from <base> (excluded) for <nbpar> parameters; <nbpar> = 0 commands to take list length. Default is (1 to skip type)

param list

type list

Interface_ParamList

param ach

type ach

Interface_Check

param base

default value is 1

type base

int

param nbpar

default value is 0

type nbpar

int

param num

default value is 0

type num

int

rtype

None

AddFail()¶

Parameters

afail –

type afail: char *
param bfail: default value is
type bfail: char *
rtype: None* feeds the Check with a new fail (as a String or as a CString)
param af
type af: TCollection_HAsciiString
param bf
type bf: TCollection_HAsciiString
rtype: None

AddWarning()¶

Parameters

awarn –

type awarn: char *
param bwarn: default value is
type bwarn: char *
rtype: None* feeds the Check with a new Warning message
param aw
type aw: TCollection_HAsciiString
param bw
type bw: TCollection_HAsciiString
rtype: None

CCheck()¶

returns the check in a way which allows to work on it directly (i.e. messages added to the Check are added to ParamReader too)

rtype

opencascade::handle<Interface_Check>

Check()¶

returns the Check Note that any error signaled above is also recorded into it

rtype

opencascade::handle<Interface_Check>

Clear()¶

resets state (stage, current param number, check with no fail)

rtype

None

Current()¶

Creates a ParamCursor from the Current Number, to read one parameter, and to advance Current Number after reading

rtype

IGESData_ParamCursor

CurrentList()¶

Creates a ParamCursor from the Current Number, to read a list of ‘nb’ items, and to advance Current Number after reading By default, each item is made of one parameter If size is given, it precises the number of params per item

param nb

type nb

int

param size

default value is 1

type size

int

rtype

IGESData_ParamCursor

CurrentNumber()¶

returns the current parameter number This notion is involved by the organisation of an IGES list of parameterit can be ended by two lists (Associativities and Properties), which can be empty, or even absent. Hence, it is necessary to know, at the end of specific reading, how many parameters have been readthe optionnal lists follow

rtype

int

DefinedElseSkip()¶

Allows to simply process a parameter which can be defaulted. Waits on the Current Number a defined parameter or skips itIf the parameter <num> is defined, changes nothing and returns True Hence, the next reading with current cursor will concern <num> If it is void, advances Current Position by one, and returns False The next reading will concern <num+1> (except if <num> = NbParams) //! This allows to process Default values as follows (C++)if (PR.DefinedElseSkip()) { .. PR.Read… (current parameter); } else { <current parameter> = default value .. nothing else to do with ParamReader } For Message

rtype

bool

EndAll()¶

passes directly to the end of reading process

rtype

None

EntityNumber()¶

Returns the entity number in the file

rtype

int

HasFailed()¶

says if fails have been recorded into the Check

rtype

bool

IsCheckEmpty()¶

Returns True if the Check is Empty Else, it has to be recorded with the Read Entity

rtype

bool

IsParamDefined()¶

says if a parameter is defined (not void) See also DefinedElseSkip

param num

type num

int

rtype

bool

IsParamEntity()¶

says if a parameter can be regarded as an entity reference (see Prepare from IGESReaderData for more explanation) Note that such a parameter can seen as be a plain Integer too

param num

type num

int

rtype

bool

Mend()¶

Parameters: pref – default value is :type pref: char * :rtype: None

NbParams()¶

returns number of parameters (minus the first one) following method skip the first parameter (1 gives the 2nd)

rtype

int

NextStage()¶

passes to next stage (must be linked with setting Current)

rtype

None

ParamEntity()¶

directly returns entity referenced by a parameter

param IR

type IR

IGESData_IGESReaderData

param num

type num

int

rtype

opencascade::handle<IGESData_IGESEntity>

ParamNumber()¶

returns entity number corresponding to a parameter if there is otherwise zero (according criterium IsParamEntity)

param num

type num

int

rtype

int

ParamType()¶

returns type of parameter; note that ‘Ident’ or ‘Sub’ cannot be encountered, they correspond to ‘Integer’, see also below

param num

type num

int

rtype

Interface_ParamType

ParamValue()¶

returns litteral value of a parameter, as it was in file

param num

type num

int

rtype

char *

ReadBoolean()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: bool
param exact: default value is Standard_True
type exact: bool
rtype: bool* Reads a Boolean value from parameter ‘num’ A Boolean is given as an Integer value 0 (False) or 1 (True) Anyway, an Integer is demanded (else, Check is filled) If exact is given True, those precise values are demanded Else, Correction is done, as False for 0 or <0, True for >0 (with a Warning error message, and return is True) In case of error (not an Integer, or not 0/1 and exact True), Check is filled with a Fail (using mess) and return is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: bool
param exact: default value is Standard_True
type exact: bool
rtype: bool

ReadEntList()¶

Parameters

IR –

type IR: IGESData_IGESReaderData
param PC
type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: Interface_EntityList
param ord: default value is Standard_True
type ord: bool
rtype: bool* Reads a list of Entities defined by PC Same conditions as for ReadEnts, for PC The list is given as an EntityList (index has no meaning; the EntityList starts from clear) If ‘ord’ is given True (default), entities will be added to the list in their original order Remark : Negative or Null Pointers are ignored Else (‘ord’ False), order is not garanteed (faster mode) If all params cannot be read as Entities, same as above Warning Give ‘ord’ to False ONLY if order is not significant
param IR
type IR: IGESData_IGESReaderData
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: Interface_EntityList
param ord: default value is Standard_True
type ord: bool
rtype: bool

ReadEnts()¶

Parameters

IR –

type IR: IGESData_IGESReaderData
param PC
type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: IGESData_HArray1OfIGESEntity
param index: default value is 1
type index: int
rtype: bool* Reads a list of Entities defined by PC Same conditions as for ReadInts, for PC and index The list is given as a HArray1, numered from ‘index’ If all params cannot be read as Entities, Check is filled (using mess) and return value is False Remark : Null references are accepted, they are ignored (negative pointers too : they provoke a Warning message) If the caller wants to check them, a loop on ReadEntity should be used
param IR
type IR: IGESData_IGESReaderData
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: IGESData_HArray1OfIGESEntity
param index: default value is 1
type index: int
rtype: bool

ReadInteger()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param val
type val: int
rtype: bool* Reads an Integer value designated by PC The method Current designates the current parameter and advances the Current Number by one after reading Note that if a count (not 1) is given, it is ignored If it is not an Integer, fills Check with a Fail (using mess) and returns False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: int
rtype: bool

ReadInts()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: TColStd_HArray1OfInteger
param index: default value is 1
type index: int
rtype: bool* Reads a list of Integer values, defined by PC (with a count of parameters). PC can start from Current Number and command it to advance after reading (use method CurrentList to do this) The list is given as a HArray1, numered from ‘index’ If all params are not Integer, Check is filled (using mess) and return value is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: TColStd_HArray1OfInteger
param index: default value is 1
type index: int
rtype: bool

ReadReal()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param val
type val: float
rtype: bool* Reads a Real value from parameter ‘num’ An Integer is accepted (Check is filled with a Warning message) and causes return to be True (as normal case) In other cases, Check is filled with a Fail and return is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: float
rtype: bool

ReadReals()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: TColStd_HArray1OfReal
param index: default value is 1
type index: int
rtype: bool* Reads a list of Real values defined by PC Same conditions as for ReadInts, for PC and index An Integer parameter is accepted, if at least one parameter is Integer, Check is filled with a ‘Warning’ message If all params are neither Real nor Integer, Check is filled (using mess) and return value is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: TColStd_HArray1OfReal
param index: default value is 1
type index: int
rtype: bool

ReadText()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: TCollection_HAsciiString
rtype: bool* Reads a Text value from parameter ‘num’, as a String from Collection, that is, Hollerith text without leading ‘nnnH’ If it is not a String, fills Check with a Fail (using mess) and returns False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: TCollection_HAsciiString
rtype: bool

ReadTexts()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: Interface_HArray1OfHAsciiString
param index: default value is 1
type index: int
rtype: bool* Reads a list of Hollerith Texts, defined by PC Texts are read as Hollerith texts without leading ‘nnnH’ Same conditions as for ReadInts, for PC and index If all params are not Text, Check is filled (using mess) and return value is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: Interface_HArray1OfHAsciiString
param index: default value is 1
type index: int
rtype: bool

ReadXY()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: gp_XY
rtype: bool* Reads a couple of Real values (X,Y) from parameter ‘num’ Integers are accepted (Check is filled with a Warning message) and cause return to be True (as normal case) In other cases, Check is filled with a Fail and return is False
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: gp_XY
rtype: bool

ReadXYZ()¶

Parameters

PC –

type PC: IGESData_ParamCursor
param amsg
type amsg: Message_Msg
param val
type val: gp_XYZ
rtype: bool* Reads a triplet of Real values (X,Y,Z) from parameter ‘num’ Integers are accepted (Check is filled with a Warning message) and cause return to be True (as normal case) In other cases, Check is filled with a Fail and return is False For Message
param PC
type PC: IGESData_ParamCursor
param mess
type mess: char *
param val
type val: gp_XYZ
rtype: bool

ReadingEntityNumber()¶

Parameters

num –

type num: int
param val
type val: int
rtype: bool* Routine which reads an Entity Number (which allows to read the Entity in the IGESReaderData by BoundEntity), given its number in the list of Parameters Same conditions as ReadEntity for mess, val, and return value In particular, returns True and val to zero means Null Entity, and val not zero means Entity read by BoundEntity
param num
type num: int
param mess
type mess: char *
param val
type val: int
rtype: bool

ReadingReal()¶

Parameters

num –

type num: int
param val
type val: float
rtype: bool* Routine which reads a Real parameter, given its number Same conditions as ReadReal for mess, val, and return value
param num
type num: int
param mess
type mess: char *
param val
type val: float
rtype: bool

SendFail()¶

Parameters

amsg –

type amsg: Message_Msg
rtype: None

SendWarning()¶

Parameters

amsg –

type amsg: Message_Msg
rtype: None

SetCurrentNumber()¶

sets current parameter number to a new value must be done at end of each stepset on first parameter following last read one; is done by some Read… methods (must be done directly if these method are not used) num greater than NbParams means that following lists are empty If current num is not managed, it remains at 1, which probably will cause error when successive steps of reading are made

param num

type num

int

rtype

None

Stage()¶

gives current stage (Own-Props-Assocs-End, begins at Own)

rtype

IGESData_ReadStage

property thisown¶: The membership flag

class IGESData_Protocol(*args)¶

Bases: OCC.Core.Interface.Interface_Protocol

Return type: None

static DownCast(t)¶

property thisown¶: The membership flag

class IGESData_ReadWriteModule(*args, **kwargs)¶

Bases: OCC.Core.Interface.Interface_ReaderModule

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

CaseIGES()¶

Defines Case Numbers corresponding to the Entity Types taken into account by a sub-class of ReadWriteModule (hence, each sub-class of ReadWriteModule has to redefine this method) Called by CaseNum. Its result will then be used to call Read, etc …

param typenum

type typenum

int

param formnum

type formnum

int

rtype

int

static DownCast(t)¶

ReadOwnParams()¶

Reads own parameters from file for an Entity; <PR> gives access to them, <IR> detains parameter types and values For each class, there must be a specific action provided Note that Properties and Associativities Lists are Read by specific methods (see below), they are called under control of reading process (only one call) according Stage recorded in ParamReader

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param IR

type IR

IGESData_IGESReaderData

param PR

type PR

IGESData_ParamReader

rtype

void

WriteOwnParams()¶

Writes own parameters to IGESWriter; defined for each class (to be redefined for other IGES ReadWriteModules) WarningProperties and Associativities are directly managed by WriteIGES, must not be sent by this method

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param IW

type IW

IGESData_IGESWriter

rtype

void

property thisown¶: The membership flag

class IGESData_SingleParentEntity(*args, **kwargs)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

Child()¶

Returns a Child given its rank

param num

type num

int

rtype

opencascade::handle<IGESData_IGESEntity>

static DownCast(t)¶

NbChildren()¶

Returns the count of Entities designated as children

rtype

int

SingleParent()¶

Returns the parent designated by the Entity, if only one !

rtype

opencascade::handle<IGESData_IGESEntity>

property thisown¶: The membership flag

class IGESData_SpecificLib(*args)¶

Bases: object

Creates a Library which complies with a Protocol, that isSame class (criterium IsInstance) This creation gets the Modules from the global set, those which are bound to the given Protocol and its Resources

param aprotocol

type aprotocol

IGESData_Protocol

rtype

None* Creates an empty Library : it will later by filled by method AddProtocol

rtype

None

AddProtocol()¶

Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)

param aprotocol

type aprotocol

Standard_Transient

rtype

None

Clear()¶

Clears the list of Modules of a library (can be used to redefine the order of Modules before actionClear then refill the Library by calls to AddProtocol)

rtype

None

Module()¶

Returns the current Module in the Iteration

rtype

opencascade::handle<IGESData_SpecificModule>

More()¶

Returns True if there are more Modules to iterate on

rtype

bool

Next()¶

Iterates by getting the next Module in the list If there is none, the exception will be raised by Value

rtype

None

Protocol()¶

Returns the current Protocol in the Iteration

rtype

opencascade::handle<IGESData_Protocol>

Select()¶

Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)

param obj

type obj

IGESData_IGESEntity

param module

type module

IGESData_SpecificModule

param CN

type CN

int

rtype

bool

SetComplete()¶

Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)

rtype

None

static SetGlobal()¶

Adds a couple (Module-Protocol) into the global definition set for this class of Library.

param amodule

type amodule

IGESData_SpecificModule

param aprotocol

type aprotocol

IGESData_Protocol

rtype

void

Start()¶

Starts Iteration on the Modules (sets it on the first one)

rtype

None

property thisown¶: The membership flag

class IGESData_SpecificModule(*args, **kwargs)¶

Bases: OCC.Core.Standard.Standard_Transient

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

OwnCorrect()¶

Specific Automatic Correction on own Parameters of an Entity. It works by setting in accordance redundant data, if there are when there is no ambiguity (else, it does nothing). Remark that classic Corrections on Directory Entry (to set void data) are taken into account alsewhere. //! For instance, many ‘Associativity Entities’ have a Number of Properties which must have a fixed value. Or, a ConicalArc has its Form Number which records the kind of Conic, also determined from its coefficients But, a CircularArc of which Distances (Center-Start) and (Center-End) are not equal cannot be corrected … //! Returns True if something has been corrected in <ent> By default, does nothing. If at least one of the Types processed by a sub-class of SpecificModule has a Correct procedure attached, this method can be redefined

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

rtype

bool

OwnDump()¶

Specific Dump for each type of IGES Entityit concerns only own parameters, the general data (Directory Part, Lists) are taken into account by the IGESDumper See class IGESDumper for the rules to follow for <own> and <attached> level

param CN

type CN

int

param ent

type ent

IGESData_IGESEntity

param dumper

type dumper

IGESData_IGESDumper

param S

type S

Message_Messenger

param own

type own

int

rtype

void

property thisown¶: The membership flag

class IGESData_ToolLocation(*args)¶

Bases: OCC.Core.Standard.Standard_Transient

Creates a ToolLocation on a given Model, filled with the help of a Protocol (which allows to known Entities referenced by other ones)

param amodel

type amodel

IGESData_IGESModel

param protocol

type protocol

IGESData_Protocol

rtype

None

AnalyseLocation()¶

Analysis a Location given as a GTrsf, by trying to convert it to a Trsf (i.e. to a True Location of which effect is described by an Isometry or a Similarity) Works with the Precision given by default or by SetPrecision Calls ConvertLocation (see below)

param loc

type loc

gp_GTrsf

param result

type result

gp_Trsf

rtype

bool

static ConvertLocation()¶

Convertion of a Location, from GTrsf form to Trsf form Works with a precision given as argument. Returns True if the Conversion is possible, (hence, <result> contains the converted location), False else <unit>, if given, indicates the unit in which <loc> is defined in meters. It concerns the translation part (to be converted. //! As a class method, it can be called separately

param prec

type prec

float

param loc

type loc

gp_GTrsf

param result

type result

gp_Trsf

param uni

default value is 1

type uni

float

rtype

bool

static DownCast(t)¶

EffectiveLocation()¶

Returns the effective Location of an Entity, i.e. the composition of its proper Transformation Matrix (returned by Transf) and its Parent’s Location (returned by ParentLocation)

param ent

type ent

IGESData_IGESEntity

rtype

gp_GTrsf

ExplicitLocation()¶

Returns the Explicit Location defined by the Transformation Matrix of <ent>. Identity if there is none

param ent

type ent

IGESData_IGESEntity

rtype

gp_GTrsf

HasParent()¶

Returns True if <ent> is dependent from one and only one other Entity, either by Reference or by Associativity

param ent

type ent

IGESData_IGESEntity

rtype

bool

HasParentByAssociativity()¶

Returns True if the Parent, if there is one, is defined by a SingleParentEntity Associativity Else, if HasParent is True, it is by Reference

param ent

type ent

IGESData_IGESEntity

rtype

bool

HasTransf()¶

Returns True if <ent> has a Transformation Matrix in proper (referenced from its Directory Part)

param ent

type ent

IGESData_IGESEntity

rtype

bool

IsAmbiguous()¶

Returns True if more than one Parent has been determined for <ent>, by adding direct References and Associativities

param ent

type ent

IGESData_IGESEntity

rtype

bool

IsAssociativity()¶

Returns True if <ent> is an Associativity (IGES Type 402). Then, Location does not apply.

param ent

type ent

IGESData_IGESEntity

rtype

bool

IsTransf()¶

Returns True if <ent> is kind of TransfEntity. Then, it has no location, while it can be used to define a Location)

param ent

type ent

IGESData_IGESEntity

rtype

bool

Load()¶

Does the effective work of determining Locations of Entities

rtype

None

Parent()¶

Returns the unique Parent recorded for <ent>. Returns a Null Handle if there is none

param ent

type ent

IGESData_IGESEntity

rtype

opencascade::handle<IGESData_IGESEntity>

ParentLocation()¶

Returns the effective Location of the Parent of <ent>, if there is onethis Location is itself given as compound according dependences on the Parent, if there are some. Returns an Identity Transformation if no Parent is recorded.

param ent

type ent

IGESData_IGESEntity

rtype

gp_GTrsf

ResetDependences()¶

Resets all informations about dependences for <child>

param child

type child

IGESData_IGESEntity

rtype

None

SetOwnAsDependent()¶

Unitary action which defines Entities referenced by <ent> (except those in Directory Part and Associativities List) as Dependent (their Locations are related to that of <ent>)

param ent

type ent

IGESData_IGESEntity

rtype

None

SetParentAssoc()¶

Sets the ‘Associativity’ information for <child> as being <parent> (it must be the Parent itself, not the Associativity)

param parent

type parent

IGESData_IGESEntity

param child

type child

IGESData_IGESEntity

rtype

None

SetPrecision()¶

Sets a precision for the Analysis of Locations (default by constructor is 1.E-05)

param prec

type prec

float

rtype

None

SetReference()¶

Sets the ‘Reference’ information for <child> as being <parent> Sets an Error Status if already set (see method IsAmbiguous)

param parent

type parent

IGESData_IGESEntity

param child

type child

IGESData_IGESEntity

rtype

None

property thisown¶: The membership flag

class IGESData_TransfEntity(*args, **kwargs)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

Value()¶

gives value of the transformation, as a GTrsf To be defined by an effective class of Transformation Entity WarningMust take in account Compositionif a TransfEntity has in its Directory Part, a Transf, this means that it is Compound, Value must return the global result

rtype

gp_GTrsf

property thisown¶: The membership flag

class IGESData_UndefinedEntity(*args)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

creates an unknown entity

rtype

None

ChangeableContent()¶

Returns own data as an UndefinedContent, in order to touch it

rtype

opencascade::handle<Interface_UndefinedContent>

DirStatus()¶

returns Directory Error Status (used for Copy)

rtype

int

static DownCast(t)¶

IsOKDirPart()¶

says if DirPart is OK or not (if not, it is erroneous) Note that if it is not, Def* methods can return Error status

rtype

bool

ReadDir()¶

Computes the Directory Error Status, to be called before standard ReadDir from IGESReaderTool Returns True if OK (hence, Directory can be loaded), Else returns False and the DirPart <DP> is modified (hence, Directory Error Status is non null; and standard Read will work with an acceptable DirectoryPart)

param IR

type IR

IGESData_IGESReaderData

param DP

type DP

IGESData_DirPart

param ach

type ach

Interface_Check

rtype

bool

ReadOwnParams()¶

reads own parameters from file; PR gives access to them, IR detains parameter types and values Here, reads all parameters, integers are considered as entity reference unless they cannot be; no list interpretation No property or associativity list is managed

param IR

type IR

IGESData_IGESReaderData

param PR

type PR

IGESData_ParamReader

rtype

void

SetNewContent()¶

Redefines a completely new UndefinedContent Used by a Copy which begins by ShallowCopy, for instance

param cont

type cont

Interface_UndefinedContent

rtype

None

SetOKDirPart()¶

Erases the Directory Error Status WarningBe sure that data are consistent to call this method …

rtype

None

UndefinedContent()¶

Returns own data as an UndefinedContent

rtype

opencascade::handle<Interface_UndefinedContent>

WriteOwnParams()¶

writes parameters to IGESWriter, taken from UndefinedContent

param IW

type IW

IGESData_IGESWriter

rtype

void

property thisown¶: The membership flag

class IGESData_ViewKindEntity(*args, **kwargs)¶

Bases: OCC.Core.IGESData.IGESData_IGESEntity

Empty constructor

Return type: None* Copy constructor – does nothing
Parameters: & (Standard_Transient) –
Return type: None

static DownCast(t)¶

IsSingle()¶

says if ‘me’ is a Single View (True) or a List of Views (False)

rtype

bool

NbViews()¶

Returns the count of Views for a List of Views. For a Single View, may return simply 1

rtype

int

ViewItem()¶

Returns the View n0. <num> for a List of Views. For a Single Views, may return <self> itself

param num

type num

int

rtype

opencascade::handle<IGESData_ViewKindEntity>

property thisown¶: The membership flag

class IGESData_WriterLib(*args)¶

Bases: object

Creates a Library which complies with a Protocol, that isSame class (criterium IsInstance) This creation gets the Modules from the global set, those which are bound to the given Protocol and its Resources

param aprotocol

type aprotocol

IGESData_Protocol

rtype

None* Creates an empty Library : it will later by filled by method AddProtocol

rtype

None

AddProtocol()¶

Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)

param aprotocol

type aprotocol

Standard_Transient

rtype

None

Clear()¶

Clears the list of Modules of a library (can be used to redefine the order of Modules before actionClear then refill the Library by calls to AddProtocol)

rtype

None

Module()¶

Returns the current Module in the Iteration

rtype

opencascade::handle<IGESData_ReadWriteModule>

More()¶

Returns True if there are more Modules to iterate on

rtype

bool

Next()¶

Iterates by getting the next Module in the list If there is none, the exception will be raised by Value

rtype

None

Protocol()¶

Returns the current Protocol in the Iteration

rtype

opencascade::handle<IGESData_Protocol>

Select()¶

Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)

param obj

type obj

IGESData_IGESEntity

param module

type module

IGESData_ReadWriteModule

param CN

type CN

int

rtype

bool

SetComplete()¶

Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)

rtype

None

static SetGlobal()¶

Adds a couple (Module-Protocol) into the global definition set for this class of Library.

param amodule

type amodule

IGESData_ReadWriteModule

param aprotocol

type aprotocol

IGESData_Protocol

rtype

void

Start()¶

Starts Iteration on the Modules (sets it on the first one)

rtype

None

property thisown¶: The membership flag

class SwigPyIterator(*args, **kwargs)¶

Bases: object

advance()¶

copy()¶

decr()¶

distance()¶

equal()¶

incr()¶

next()¶

previous()¶

property thisown¶: The membership flag

value()¶

class igesdata¶

Bases: object

static Init()¶

Prepares General dynamic data used for IGESData specificallyProtocol and Modules, which treat UndefinedEntity

rtype

void

static Protocol()¶

Returns a Protocol from IGESData (avoids to create it)

rtype

opencascade::handle<IGESData_Protocol>

property thisown¶: The membership flag