 |
Open CASCADE Technology Reference Manual 8.0.0
|
Loading...
Searching...
No Matches
|
Open CASCADE Technology Reference Manual 8.0.0
|
Storage root data section contains root persistent objects. More...
#include <StdStorage_RootData.hxx>
Public Member Functions | |
| bool | Read (const occ::handle< Storage_BaseDriver > &theDriver) |
| Reads the root data section from the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly. | |
| bool | Write (const occ::handle< Storage_BaseDriver > &theDriver) |
| Writes the root data section to the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly. | |
| int | NumberOfRoots () const |
| Returns the number of roots. | |
| void | AddRoot (const occ::handle< StdStorage_Root > &aRoot) |
| Add a root to <me>. If a root with same name is present, it will be replaced by <aRoot>. | |
| occ::handle< NCollection_HSequence< occ::handle< StdStorage_Root > > > | Roots () const |
| Returns a sequence of all roots. | |
| occ::handle< StdStorage_Root > | Find (const TCollection_AsciiString &aName) const |
| Finds a root with name <aName>. | |
| bool | IsRoot (const TCollection_AsciiString &aName) const |
| Returns true if <me> contains a root named <aName> | |
| void | RemoveRoot (const TCollection_AsciiString &aName) |
| Removes the root named <aName>. | |
| Storage_Error | ErrorStatus () const |
| Returns a status of the latest call to Read / Write functions. | |
| TCollection_AsciiString | ErrorStatusExtension () const |
| Returns an error message if any of the latest call to Read / Write functions. | |
| void | ClearErrorStatus () |
| Clears error status. | |
| void | Clear () |
| Removes all persistent root objects. | |
 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. | |
Storage root data section contains root persistent objects.
| void StdStorage_RootData::AddRoot | ( | const occ::handle< StdStorage_Root > & | aRoot | ) |
Add a root to <me>. If a root with same name is present, it will be replaced by <aRoot>.
| void StdStorage_RootData::Clear | ( | ) |
Removes all persistent root objects.
| void StdStorage_RootData::ClearErrorStatus | ( | ) |
Clears error status.
| Storage_Error StdStorage_RootData::ErrorStatus | ( | ) | const |
Returns a status of the latest call to Read / Write functions.
| TCollection_AsciiString StdStorage_RootData::ErrorStatusExtension | ( | ) | const |
Returns an error message if any of the latest call to Read / Write functions.
| occ::handle< StdStorage_Root > StdStorage_RootData::Find | ( | const TCollection_AsciiString & | aName | ) | const |
Finds a root with name <aName>.
| bool StdStorage_RootData::IsRoot | ( | const TCollection_AsciiString & | aName | ) | const |
Returns true if <me> contains a root named <aName>
| int StdStorage_RootData::NumberOfRoots | ( | ) | const |
Returns the number of roots.
| bool StdStorage_RootData::Read | ( | const occ::handle< Storage_BaseDriver > & | theDriver | ) |
Reads the root data section from the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
| void StdStorage_RootData::RemoveRoot | ( | const TCollection_AsciiString & | aName | ) |
Removes the root named <aName>.
| occ::handle< NCollection_HSequence< occ::handle< StdStorage_Root > > > StdStorage_RootData::Roots | ( | ) | const |
Returns a sequence of all roots.
| bool StdStorage_RootData::Write | ( | const occ::handle< Storage_BaseDriver > & | theDriver | ) |
Writes the root data section to the container defined by theDriver. Returns true in case of success. Otherwise, one need to get an error code and description using ErrorStatus and ErrorStatusExtension functions correspondingly.
1.10.0