specific FileReaderData for IGES contains header as GlobalSection, and for each Entity, its directory part as DirPart, list of Parameters as ParamSet Each Item has a DirPart, plus classically a ParamSet and the correspondent recognized Entity (inherited from FileReaderData) Parameters are accessed through specific objects, ParamReaders More...
#include <IGESData_IGESReaderData.hxx>
Inheritance diagram for IGESData_IGESReaderData:
Public Member Functions | |
| IGESData_IGESReaderData (const Standard_Integer nbe, const Standard_Integer nbp) | |
| creates IGESReaderData correctly dimensionned (for arrays) <nbe> count of entities, that is, half nb of directory lines <nbp> : count of parameters | |
| void | AddStartLine (const Standard_CString aval) |
| adds a start line to start section | |
| Handle< TColStd_HSequenceOfHAsciiString > | StartSection () const |
| Returns the Start Section in once. | |
| void | AddGlobal (const Interface_ParamType atype, const Standard_CString aval) |
| adds a parameter to global section's parameter list | |
| void | SetGlobalSection () |
| reads header (as GlobalSection) content from the ParamSet after it has been filled by successive calls to AddGlobal | |
| const IGESData_GlobalSection & | GlobalSection () const |
| returns header as GlobalSection | |
| void | SetDirPart (const Standard_Integer num, const Standard_Integer i1, const Standard_Integer i2, const Standard_Integer i3, const Standard_Integer i4, const Standard_Integer i5, const Standard_Integer i6, const Standard_Integer i7, const Standard_Integer i8, const Standard_Integer i9, const Standard_Integer i10, const Standard_Integer i11, const Standard_Integer i12, const Standard_Integer i13, const Standard_Integer i14, const Standard_Integer i15, const Standard_Integer i16, const Standard_Integer i17, const Standard_CString res1, const Standard_CString res2, const Standard_CString label, const Standard_CString subs) |
| fills a DirPart, designated by its rank (that is, (N+1)/2 if N is its first number in section D) | |
| const IGESData_DirPart & | DirPart (const Standard_Integer num) const |
| returns DirPart identified by record no (half Dsect number) | |
| void | DirValues (const Standard_Integer num, Standard_Integer &i1, Standard_Integer &i2, Standard_Integer &i3, Standard_Integer &i4, Standard_Integer &i5, Standard_Integer &i6, Standard_Integer &i7, Standard_Integer &i8, Standard_Integer &i9, Standard_Integer &i10, Standard_Integer &i11, Standard_Integer &i12, Standard_Integer &i13, Standard_Integer &i14, Standard_Integer &i15, Standard_Integer &i16, Standard_Integer &i17, Standard_CString &res1, Standard_CString &res2, Standard_CString &label, Standard_CString &subs) const |
| returns values recorded in directory part n0 <num> | |
| IGESData_IGESType | DirType (const Standard_Integer num) const |
| returns "type" and "form" info from a directory part | |
| virtual Standard_Integer | NbEntities () const override |
| Returns count of recorded Entities (i.e. size of Directory) | |
| Standard_Integer | FindNextRecord (const Standard_Integer num) const override |
| determines next suitable record from num; that is num+1 except for last one which gives 0 | |
| void | 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 Refs : every 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) | |
| Handle< Interface_Check > | GlobalCheck () const |
| Returns the recorded Global Check. | |
| void | SetDefaultLineWeight (const Standard_Real defw) |
| allows to set a default line weight, will be later applied at load time, on Entities which have no specified line weight | |
| Standard_Real | DefaultLineWeight () const |
| Returns the recorded Default Line Weight, if there is (else, returns 0) | |
 Public Member Functions inherited from Interface_FileReaderData | |
| virtual Standard_Integer | NbRecords () const |
| Returns the count of registered records That is, value given for Initialization (can be redefined) | |
| void | InitParams (const Standard_Integer num) |
| attaches an empty ParamList to a Record | |
| void | AddParam (const Standard_Integer num, const Standard_CString aval, const Interface_ParamType atype, const Standard_Integer nument=0) |
| Adds a parameter to record no "num" and fills its fields (EntityNumber is optional) Warning : <aval> is assumed to be memory-managed elsewhere : it is NOT copied. This gives a best speed : strings remain stored in pages of characters. | |
| void | AddParam (const Standard_Integer num, const TCollection_AsciiString &aval, const Interface_ParamType atype, const Standard_Integer nument=0) |
| Same as above, but gets a AsciiString from TCollection Remark that the content of the AsciiString is locally copied (because its content is most often lost after using) | |
| void | AddParam (const Standard_Integer num, const Interface_FileParameter &FP) |
| Same as above, but gets a complete FileParameter Warning : Content of <FP> is NOT copied : its original address and space in memory are assumed to be managed elsewhere (see ParamSet) | |
| void | SetParam (const Standard_Integer num, const Standard_Integer nump, const Interface_FileParameter &FP) |
| Sets a new value for a parameter of a record, given by : num : record number; nump : parameter number in the record. | |
| Standard_Integer | NbParams (const Standard_Integer num) const |
| Returns count of parameters attached to record "num" If <num> = 0, returns the total recorded count of parameters. | |
| Handle< Interface_ParamList > | Params (const Standard_Integer num) const |
| Returns the complete ParamList of a record (read only) num = 0 to return the whole param list for the file. | |
| const Interface_FileParameter & | Param (const Standard_Integer num, const Standard_Integer nump) const |
| Returns parameter "nump" of record "num", as a complete FileParameter. | |
| Interface_FileParameter & | ChangeParam (const Standard_Integer num, const Standard_Integer nump) |
| Same as above, but in order to be modified on place. | |
| Interface_ParamType | ParamType (const Standard_Integer num, const Standard_Integer nump) const |
| Returns type of parameter "nump" of record "num" Returns literal value of parameter "nump" of record "num" was C++ : return const &. | |
| Standard_CString | ParamCValue (const Standard_Integer num, const Standard_Integer nump) const |
| Same as above, but as a CString was C++ : return const. | |
| Standard_Boolean | IsParamDefined (const Standard_Integer num, const Standard_Integer nump) const |
| Returns True if parameter "nump" of record "num" is defined (it is not if its type is ParamVoid) | |
| Standard_Integer | ParamNumber (const Standard_Integer num, const Standard_Integer nump) const |
| Returns record number of an entity referenced by a parameter of type Ident; 0 if no EntityNumber has been determined Note that it is used to reference Entities but also Sublists (sublists are not objects, but internal descriptions) | |
| const Handle< Standard_Transient > & | ParamEntity (const Standard_Integer num, const Standard_Integer nump) const |
| Returns the StepEntity referenced by a parameter Error if none. | |
| Standard_Integer | ParamFirstRank (const Standard_Integer num) const |
| Returns the absolute rank of the beginning of a record (its list is from ParamFirstRank+1 to ParamFirstRank+NbParams) | |
| const Handle< Standard_Transient > & | BoundEntity (const Standard_Integer num) const |
| Returns the entity bound to a record, set by SetEntities. | |
| void | BindEntity (const Standard_Integer num, const Handle< Standard_Transient > &ent) |
| Binds an entity to a record. | |
| void | SetErrorLoad (const Standard_Boolean val) |
| Sets the status "Error Load" on, to overside check fails <val> True : declares unloaded <val> False : declares loaded If not called before loading (see FileReaderTool), check fails give the status IsErrorLoad says if SetErrorLoad has been called by user ResetErrorLoad resets it (called by FileReaderTool) This allows to specify that the currently loaded entity remains unloaded (because of syntactic fail) | |
| Standard_Boolean | IsErrorLoad () const |
| Returns True if the status "Error Load" has been set (to True or False) | |
| Standard_Boolean | ResetErrorLoad () |
| Returns the former value of status "Error Load" then resets it Used to read the status then ensure it is reset. | |
| void | Destroy () |
| Destructor (waiting for memory management) | |
| ~Interface_FileReaderData () | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
| Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
| Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
| Static Public Member Functions inherited from Interface_FileReaderData | |
| static Standard_Real | Fastof (const Standard_CString str) |
| Same spec.s as standard <atof> but 5 times faster. | |
| Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
| Protected Member Functions inherited from Interface_FileReaderData | |
| Interface_FileReaderData (const Standard_Integer nbr, const Standard_Integer npar) | |
| Initializes arrays of Entities and of ParamLists attached to registered records <nbr> must be the maximum number of records to get (no way to extend it at run-time) : count entities and sub-entities ... <npar> is the total count of parameters (if it is not exact, it will be extended as necessary) | |
| Interface_FileParameter & | ChangeParameter (const Standard_Integer numpar) |
| Returns a parameter given its absolute rank in the file in order to be consulted or modified in specilaized actions. | |
| void | ParamPosition (const Standard_Integer numpar, Standard_Integer &num, Standard_Integer &nump) const |
| For a given absolute rank of parameter, determines the record to which its belongs, and the parameter number for it. | |
Detailed Description
specific FileReaderData for IGES contains header as GlobalSection, and for each Entity, its directory part as DirPart, list of Parameters as ParamSet Each Item has a DirPart, plus classically a ParamSet and the correspondent recognized Entity (inherited from FileReaderData) Parameters are accessed through specific objects, ParamReaders
Constructor & Destructor Documentation
◆ IGESData_IGESReaderData()
| IGESData_IGESReaderData::IGESData_IGESReaderData | ( | const Standard_Integer | nbe, |
| const Standard_Integer | nbp | ||
| ) |
creates IGESReaderData correctly dimensionned (for arrays) <nbe> count of entities, that is, half nb of directory lines <nbp> : count of parameters
Member Function Documentation
◆ AddGlobal()
| void IGESData_IGESReaderData::AddGlobal | ( | const Interface_ParamType | atype, |
| const Standard_CString | aval | ||
| ) |
adds a parameter to global section's parameter list
◆ AddStartLine()
| void IGESData_IGESReaderData::AddStartLine | ( | const Standard_CString | aval | ) |
adds a start line to start section
◆ DefaultLineWeight()
| Standard_Real IGESData_IGESReaderData::DefaultLineWeight | ( | ) | const |
Returns the recorded Default Line Weight, if there is (else, returns 0)
◆ DirPart()
| const IGESData_DirPart & IGESData_IGESReaderData::DirPart | ( | const Standard_Integer | num | ) | const |
returns DirPart identified by record no (half Dsect number)
◆ DirType()
| IGESData_IGESType IGESData_IGESReaderData::DirType | ( | const Standard_Integer | num | ) | const |
returns "type" and "form" info from a directory part
◆ DirValues()
| void IGESData_IGESReaderData::DirValues | ( | const Standard_Integer | num, |
| Standard_Integer & | i1, | ||
| Standard_Integer & | i2, | ||
| Standard_Integer & | i3, | ||
| Standard_Integer & | i4, | ||
| Standard_Integer & | i5, | ||
| Standard_Integer & | i6, | ||
| Standard_Integer & | i7, | ||
| Standard_Integer & | i8, | ||
| Standard_Integer & | i9, | ||
| Standard_Integer & | i10, | ||
| Standard_Integer & | i11, | ||
| Standard_Integer & | i12, | ||
| Standard_Integer & | i13, | ||
| Standard_Integer & | i14, | ||
| Standard_Integer & | i15, | ||
| Standard_Integer & | i16, | ||
| Standard_Integer & | i17, | ||
| Standard_CString & | res1, | ||
| Standard_CString & | res2, | ||
| Standard_CString & | label, | ||
| Standard_CString & | subs | ||
| ) | const |
returns values recorded in directory part n0 <num>
◆ FindNextRecord()
|
overridevirtual |
determines next suitable record from num; that is num+1 except for last one which gives 0
Implements Interface_FileReaderData.
◆ GlobalCheck()
| Handle< Interface_Check > IGESData_IGESReaderData::GlobalCheck | ( | ) | const |
Returns the recorded Global Check.
◆ GlobalSection()
| const IGESData_GlobalSection & IGESData_IGESReaderData::GlobalSection | ( | ) | const |
returns header as GlobalSection
◆ NbEntities()
|
overridevirtual |
Returns count of recorded Entities (i.e. size of Directory)
Reimplemented from Interface_FileReaderData.
◆ SetDefaultLineWeight()
| void IGESData_IGESReaderData::SetDefaultLineWeight | ( | const Standard_Real | defw | ) |
allows to set a default line weight, will be later applied at load time, on Entities which have no specified line weight
◆ SetDirPart()
| void IGESData_IGESReaderData::SetDirPart | ( | const Standard_Integer | num, |
| const Standard_Integer | i1, | ||
| const Standard_Integer | i2, | ||
| const Standard_Integer | i3, | ||
| const Standard_Integer | i4, | ||
| const Standard_Integer | i5, | ||
| const Standard_Integer | i6, | ||
| const Standard_Integer | i7, | ||
| const Standard_Integer | i8, | ||
| const Standard_Integer | i9, | ||
| const Standard_Integer | i10, | ||
| const Standard_Integer | i11, | ||
| const Standard_Integer | i12, | ||
| const Standard_Integer | i13, | ||
| const Standard_Integer | i14, | ||
| const Standard_Integer | i15, | ||
| const Standard_Integer | i16, | ||
| const Standard_Integer | i17, | ||
| const Standard_CString | res1, | ||
| const Standard_CString | res2, | ||
| const Standard_CString | label, | ||
| const Standard_CString | subs | ||
| ) |
fills a DirPart, designated by its rank (that is, (N+1)/2 if N is its first number in section D)
◆ SetEntityNumbers()
| void IGESData_IGESReaderData::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 Refs : every 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)
◆ SetGlobalSection()
| void IGESData_IGESReaderData::SetGlobalSection | ( | ) |
reads header (as GlobalSection) content from the ParamSet after it has been filled by successive calls to AddGlobal
◆ StartSection()
| Handle< TColStd_HSequenceOfHAsciiString > IGESData_IGESReaderData::StartSection | ( | ) | const |
Returns the Start Section in once.
The documentation for this class was generated from the following file:
