Files
OCCT/src/IGESSelect/IGESSelect_AddFileComment.hxx
luz paz 0177fe2617 0031939: Coding - correction of spelling errors in comments [part 4]
Fix various typos

Fixed via `codespell v2.1.dev
2020-12-17 21:17:43 +03:00

100 lines
3.0 KiB
C++

// Created on: 1994-08-26
// Created by: Christian CAILLET
// Copyright (c) 1994-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.
#ifndef _IGESSelect_AddFileComment_HeaderFile
#define _IGESSelect_AddFileComment_HeaderFile
#include <Standard.hxx>
#include <Standard_Type.hxx>
#include <TColStd_HSequenceOfHAsciiString.hxx>
#include <IGESSelect_FileModifier.hxx>
#include <Standard_CString.hxx>
#include <Standard_Integer.hxx>
class IFSelect_ContextWrite;
class IGESData_IGESWriter;
class TCollection_AsciiString;
class IGESSelect_AddFileComment;
DEFINE_STANDARD_HANDLE(IGESSelect_AddFileComment, IGESSelect_FileModifier)
//! 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.
class IGESSelect_AddFileComment : public IGESSelect_FileModifier
{
public:
//! Creates a new empty AddFileComment. Use AddLine to complete it
Standard_EXPORT IGESSelect_AddFileComment();
//! Clears the list of file comment lines already stored
Standard_EXPORT void Clear();
//! 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.
Standard_EXPORT void AddLine (const Standard_CString line);
//! Adds a list of lines for file comment
//! Each of them must comply with demand of AddLine
Standard_EXPORT void AddLines (const Handle(TColStd_HSequenceOfHAsciiString)& lines);
//! Returns the count of stored lines
Standard_EXPORT Standard_Integer NbLines() const;
//! Returns a stored line given its rank
Standard_EXPORT Standard_CString Line (const Standard_Integer num) const;
//! Returns the complete list of lines in once
Standard_EXPORT Handle(TColStd_HSequenceOfHAsciiString) Lines() const;
//! Sends the comment lines to the file (Start Section)
Standard_EXPORT void Perform (IFSelect_ContextWrite& ctx, IGESData_IGESWriter& writer) const Standard_OVERRIDE;
//! Returns specific Label, which is
//! "Add <nn> Comment Lines (Start Section)"
Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
DEFINE_STANDARD_RTTIEXT(IGESSelect_AddFileComment,IGESSelect_FileModifier)
protected:
private:
Handle(TColStd_HSequenceOfHAsciiString) thelist;
};
#endif // _IGESSelect_AddFileComment_HeaderFile