// Created on: 1995-09-01 // Created by: Christian CAILLET // Copyright (c) 1995-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 _Interface_BitMap_HeaderFile #define _Interface_BitMap_HeaderFile #include #include #include #include #include #include #include #include //! A bit map simply allows to associate a boolean flag to each //! item of a list, such as a list of entities, etc... numbered //! between 1 and a positive count nbitems //! //! The BitMap class allows to associate several binary flags, //! each of one is identified by a number from 0 to a count //! which can remain at zero or be positive : nbflags //! //! Flags lists over than numflag=0 are added after creation //! Each of one can be named, hence the user can identify it //! either by its flag number or by a name which gives a flag n0 //! (flag n0 0 has no name) class Interface_BitMap { public: DEFINE_STANDARD_ALLOC //! Creates a empty BitMap Standard_EXPORT Interface_BitMap(); //! Creates a BitMap for items //! One flag is defined, n0 0 //! prepares allocation for more flags //! Flags values start at false Standard_EXPORT Interface_BitMap(const Standard_Integer nbitems, const Standard_Integer resflags = 0); //! Initialize empty bit by items //! One flag is defined, n0 0 //! prepares allocation for more flags //! Flags values start at false Standard_EXPORT void Initialize (const Standard_Integer nbitems, const Standard_Integer resflags = 0); //! Creates a BitMap from another one //! if is True, copies data //! else, data are not copied, only the header object is Standard_EXPORT Interface_BitMap(const Interface_BitMap& other, const Standard_Boolean copied = Standard_False); //! Initialize a BitMap from another one Standard_EXPORT void Initialize (const Interface_BitMap& other, const Standard_Boolean copied = Standard_False); //! Reservates for a count of more flags Standard_EXPORT void Reservate (const Standard_Integer moreflags); //! Sets for a new count of items, which can be either less or //! greater than the former one //! For new items, their flags start at false Standard_EXPORT void SetLength (const Standard_Integer nbitems); //! Adds a flag, a name can be attached to it //! Returns its flag number //! Makes required reservation Standard_EXPORT Standard_Integer AddFlag (const Standard_CString name = ""); //! Adds several flags () with no name //! Returns the number of last added flag Standard_EXPORT Standard_Integer AddSomeFlags (const Standard_Integer more); //! Removes a flag given its number. //! Returns True if done, false if num is out of range Standard_EXPORT Standard_Boolean RemoveFlag (const Standard_Integer num); //! Sets a name for a flag, given its number //! name can be empty (to erase the name of a flag) //! Returns True if done, false if : num is out of range, or //! name non-empty already set to another flag Standard_EXPORT Standard_Boolean SetFlagName (const Standard_Integer num, const Standard_CString name); //! Returns the count of flags (flag 0 not included) Standard_EXPORT Standard_Integer NbFlags() const; //! Returns the count of items (i.e. the length of the bitmap) Standard_EXPORT Standard_Integer Length() const; //! Returns the name recorded for a flag, or an empty string Standard_EXPORT Standard_CString FlagName (const Standard_Integer num) const; //! Returns the number or a flag given its name, or zero Standard_EXPORT Standard_Integer FlagNumber (const Standard_CString name) const; //! Returns the value (true/false) of a flag, from : //! - the number of the item //! - the flag number, by default 0 Standard_EXPORT Standard_Boolean Value (const Standard_Integer item, const Standard_Integer flag = 0) const; //! Sets a new value for a flag Standard_EXPORT void SetValue (const Standard_Integer item, const Standard_Boolean val, const Standard_Integer flag = 0) const; //! Sets a flag to True Standard_EXPORT void SetTrue (const Standard_Integer item, const Standard_Integer flag = 0) const; //! Sets a flag to False Standard_EXPORT void SetFalse (const Standard_Integer item, const Standard_Integer flag = 0) const; //! Returns the former value for a flag and sets it to True //! (before : value returned; after : True) Standard_EXPORT Standard_Boolean CTrue (const Standard_Integer item, const Standard_Integer flag = 0) const; //! Returns the former value for a flag and sets it to False //! (before : value returned; after : False) Standard_EXPORT Standard_Boolean CFalse (const Standard_Integer item, const Standard_Integer flag = 0) const; //! Initialises all the values of Flag Number to a given //! value Standard_EXPORT void Init (const Standard_Boolean val, const Standard_Integer flag = 0) const; //! Clear all field of bit map Standard_EXPORT void Clear(); protected: private: Standard_Integer thenbitems; Standard_Integer thenbwords; Standard_Integer thenbflags; Handle(TColStd_HArray1OfInteger) theflags; Handle(TColStd_HSequenceOfAsciiString) thenames; }; #endif // _Interface_BitMap_HeaderFile