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:

[legend]

Public Member Functions
	IGESSelect_AddFileComment ()
	Creates a new empty AddFileComment. Use AddLine to complete it.

void	Clear ()
	Clears the list of file comment lines already stored.

void	AddLine (const char *const line)
	Adds a line for file comment Remark: Lines are limited to 72 useful chars. A line of more than 72 chars will be split into several ones of 72 max each.

void	AddLines (const occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > &lines)
	Adds a list of lines for file comment Each of them must comply with demand of AddLine.

int	NbLines () const
	Returns the count of stored lines.

const char *	Line (const int num) const
	Returns a stored line given its rank.

occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > >	Lines () const
	Returns the complete list of lines in once.

void	Perform (IFSelect_ContextWrite &ctx, IGESData_IGESWriter &writer) const override
	Sends the comment lines to the file (Start Section)

TCollection_AsciiString	Label () const override
	Returns specific Label, which is "Add <nn> Comment Lines (Start Section)".

Public Member Functions inherited from IFSelect_GeneralModifier
bool	MayChangeGraph () const
	Returns True if this modifier may change the graph of dependences (acknowledged at creation time)

void	SetDispatch (const occ::handle< IFSelect_Dispatch > &disp)
	Attaches to a Dispatch. If <disp> is Null, Resets it (to apply the Modifier on every Dispatch)

occ::handle< IFSelect_Dispatch >	Dispatch () const
	Returns the Dispatch to be matched, Null if not set.

bool	Applies (const occ::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>

void	SetSelection (const occ::handle< IFSelect_Selection > &sel)
	Sets a Selection : a Model is treated if it contains one or more Entities designated by the Selection.

void	ResetSelection ()
	Resets the Selection : this criterium is not longer active.

bool	HasSelection () const
	Returns True if a Selection is set as an additional criterium.

occ::handle< IFSelect_Selection >	Selection () const
	Returns the Selection, or a Null Handle if not set.

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 ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	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.

bool	IsKind (const char *const 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.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

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 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 IGESSelect_FileModifier
	IGESSelect_FileModifier ()
	Sets a File Modifier to keep the graph of dependences unchanges (because it works on the model already produced)

Protected Member Functions inherited from IFSelect_GeneralModifier
	IFSelect_GeneralModifier (const bool maychangegraph)
	Sets the Modifier criteria to default Values (i.e. "always applies") <maychangegraph> must be provided at creation time, to :

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 empty AddFileComment. Use AddLine to complete it.

Member Function Documentation

◆ AddLine()

void IGESSelect_AddFileComment::AddLine ( const char *const line )

Adds a line for file comment Remark: Lines are limited to 72 useful chars. A line of more than 72 chars will be split into several ones of 72 max each.

◆ AddLines()

void IGESSelect_AddFileComment::AddLines ( const occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > & 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()

TCollection_AsciiString IGESSelect_AddFileComment::Label ( ) const

overridevirtual

Returns specific Label, which is "Add <nn> Comment Lines (Start Section)".

Implements IFSelect_GeneralModifier.

◆ Line()

const char * IGESSelect_AddFileComment::Line ( const int num ) const

Returns a stored line given its rank.

◆ Lines()

occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > > IGESSelect_AddFileComment::Lines ( ) const

Returns the complete list of lines in once.

◆ NbLines()

int IGESSelect_AddFileComment::NbLines ( ) const

Returns the count of stored lines.

◆ Perform()

void IGESSelect_AddFileComment::Perform	(	IFSelect_ContextWrite &	ctx,
		IGESData_IGESWriter &	writer ) const