This class allows to add comment lines on writing an IGES File These lines are added to Start Section, instead of the only one blank line written by default. More...
#include <IGESSelect_AddFileComment.hxx>
Inheritance diagram for IGESSelect_AddFileComment:
Public Member Functions | |
| IGESSelect_AddFileComment () | |
| Creates a new emoty AddFileComment. Use AddLine to complete it. More... | |
| void | Clear () |
| Clears the list of file comment lines already stored. More... | |
| void | AddLine (const Standard_CString line) |
| Adds a line for file comment Remark : Lines are limited to 72 useful char.s . A line of more than 72 char.s will be splited into several ones of 72 max each. More... | |
| void | AddLines (const Handle< TColStd_HSequenceOfHAsciiString > &lines) |
| Adds a list of lines for file comment Each of them must comply with demand of AddLine. More... | |
| Standard_Integer | NbLines () const |
| Returns the count of stored lines. More... | |
| Standard_CString | Line (const Standard_Integer num) const |
| Returns a stored line given its rank. More... | |
| Handle< TColStd_HSequenceOfHAsciiString > | Lines () const |
| Returns the complete list of lines in once. More... | |
| void | Perform (IFSelect_ContextWrite &ctx, IGESData_IGESWriter &writer) const override |
| Sends the comment lines to the file (Start Section) More... | |
| TCollection_AsciiString | Label () const override |
| Returns specific Label, which is "Add <nn> Comment Lines (Start Section)". More... | |
 Public Member Functions inherited from IFSelect_GeneralModifier | |
| Standard_Boolean | MayChangeGraph () const |
| Returns True if this modifier may change the graph of dependences (aknowledged at creation time) More... | |
| void | SetDispatch (const Handle< IFSelect_Dispatch > &disp) |
| Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch) More... | |
| Handle< IFSelect_Dispatch > | Dispatch () const |
| Returns the Dispatch to be matched, Null if not set. More... | |
| Standard_Boolean | Applies (const Handle< IFSelect_Dispatch > &disp) const |
| Returns True if a Model obtained from the Dispatch <disp> is to be treated (apart from the Selection criterium) If Dispatch(me) is Null, returns True. Else, checks <disp> More... | |
| void | SetSelection (const Handle< IFSelect_Selection > &sel) |
| Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection. More... | |
| void | ResetSelection () |
| Resets the Selection : this criterium is not longer active. More... | |
| Standard_Boolean | HasSelection () const |
| Returns True if a Selection is set as an additionnal criterium. More... | |
| Handle< IFSelect_Selection > | Selection () const |
| Returns the Selection, or a Null Handle if not set. More... | |
| Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. More... | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. More... | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. More... | |
| virtual | ~Standard_Transient () |
| Destructor must be virtual. More... | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. More... | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. More... | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
| Protected Member Functions inherited from IGESSelect_FileModifier | |
| IGESSelect_FileModifier () | |
| Sets a File Modifier to keep the graph of dependences unchanges (because it works on the model already produced) More... | |
| Protected Member Functions inherited from IFSelect_GeneralModifier | |
| IFSelect_GeneralModifier (const Standard_Boolean maychangegraph) | |
| Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to : More... | |
Detailed Description
This class allows to add comment lines on writing an IGES File These lines are added to Start Section, instead of the only one blank line written by default.
Constructor & Destructor Documentation
◆ IGESSelect_AddFileComment()
| IGESSelect_AddFileComment::IGESSelect_AddFileComment | ( | ) |
Creates a new emoty AddFileComment. Use AddLine to complete it.
Member Function Documentation
◆ AddLine()
| void IGESSelect_AddFileComment::AddLine | ( | const Standard_CString | line | ) |
Adds a line for file comment Remark : Lines are limited to 72 useful char.s . A line of more than 72 char.s will be splited into several ones of 72 max each.
◆ AddLines()
| void IGESSelect_AddFileComment::AddLines | ( | const Handle< TColStd_HSequenceOfHAsciiString > & | lines | ) |
Adds a list of lines for file comment Each of them must comply with demand of AddLine.
◆ Clear()
| void IGESSelect_AddFileComment::Clear | ( | ) |
Clears the list of file comment lines already stored.
◆ Label()
|
overridevirtual |
Returns specific Label, which is "Add <nn> Comment Lines (Start Section)".
Implements IFSelect_GeneralModifier.
◆ Line()
| Standard_CString IGESSelect_AddFileComment::Line | ( | const Standard_Integer | num | ) | const |
Returns a stored line given its rank.
◆ Lines()
| Handle< TColStd_HSequenceOfHAsciiString > IGESSelect_AddFileComment::Lines | ( | ) | const |
Returns the complete list of lines in once.
◆ NbLines()
| Standard_Integer IGESSelect_AddFileComment::NbLines | ( | ) | const |
Returns the count of stored lines.
◆ Perform()
|
overridevirtual |
Sends the comment lines to the file (Start Section)
Implements IGESSelect_FileModifier.
The documentation for this class was generated from the following file:
