Open CASCADE Technology 7.8.2.dev
|
Binary persistent representation of an object. Really it is used as a buffer for read/write an object. More...
#include <BinObjMgt_Persistent.hxx>
Public Member Functions | |
BinObjMgt_Persistent () | |
Empty constructor. | |
BinObjMgt_Persistent & | PutCharacter (const Standard_Character theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_Character theValue) |
BinObjMgt_Persistent & | PutByte (const Standard_Byte theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_Byte theValue) |
BinObjMgt_Persistent & | PutExtCharacter (const Standard_ExtCharacter theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_ExtCharacter theValue) |
BinObjMgt_Persistent & | PutInteger (const Standard_Integer theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_Integer theValue) |
BinObjMgt_Persistent & | PutBoolean (const Standard_Boolean theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_Boolean theValue) |
BinObjMgt_Persistent & | PutReal (const Standard_Real theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_Real theValue) |
BinObjMgt_Persistent & | PutShortReal (const Standard_ShortReal theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_ShortReal theValue) |
BinObjMgt_Persistent & | PutCString (const Standard_CString theValue) |
Offset in output buffer is not aligned. | |
BinObjMgt_Persistent & | operator<< (const Standard_CString theValue) |
BinObjMgt_Persistent & | PutAsciiString (const TCollection_AsciiString &theValue) |
Offset in output buffer is word-aligned. | |
BinObjMgt_Persistent & | operator<< (const TCollection_AsciiString &theValue) |
BinObjMgt_Persistent & | PutExtendedString (const TCollection_ExtendedString &theValue) |
Offset in output buffer is word-aligned. | |
BinObjMgt_Persistent & | operator<< (const TCollection_ExtendedString &theValue) |
BinObjMgt_Persistent & | PutLabel (const TDF_Label &theValue) |
BinObjMgt_Persistent & | operator<< (const TDF_Label &theValue) |
BinObjMgt_Persistent & | PutGUID (const Standard_GUID &theValue) |
BinObjMgt_Persistent & | operator<< (const Standard_GUID &theValue) |
BinObjMgt_Persistent & | PutCharArray (const BinObjMgt_PChar theArray, const Standard_Integer theLength) |
Put C array of char, theLength is the number of elements. | |
BinObjMgt_Persistent & | PutByteArray (const BinObjMgt_PByte theArray, const Standard_Integer theLength) |
Put C array of unsigned chars, theLength is the number of elements. | |
BinObjMgt_Persistent & | PutExtCharArray (const BinObjMgt_PExtChar theArray, const Standard_Integer theLength) |
Put C array of ExtCharacter, theLength is the number of elements. | |
BinObjMgt_Persistent & | PutIntArray (const BinObjMgt_PInteger theArray, const Standard_Integer theLength) |
Put C array of int, theLength is the number of elements. | |
BinObjMgt_Persistent & | PutRealArray (const BinObjMgt_PReal theArray, const Standard_Integer theLength) |
Put C array of double, theLength is the number of elements. | |
BinObjMgt_Persistent & | PutShortRealArray (const BinObjMgt_PShortReal theArray, const Standard_Integer theLength) |
Put C array of float, theLength is the number of elements. | |
const BinObjMgt_Persistent & | GetCharacter (Standard_Character &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_Character &theValue) const |
const BinObjMgt_Persistent & | GetByte (Standard_Byte &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_Byte &theValue) const |
const BinObjMgt_Persistent & | GetExtCharacter (Standard_ExtCharacter &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_ExtCharacter &theValue) const |
const BinObjMgt_Persistent & | GetInteger (Standard_Integer &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_Integer &theValue) const |
const BinObjMgt_Persistent & | GetBoolean (Standard_Boolean &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_Boolean &theValue) const |
const BinObjMgt_Persistent & | GetReal (Standard_Real &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_Real &theValue) const |
const BinObjMgt_Persistent & | GetShortReal (Standard_ShortReal &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_ShortReal &theValue) const |
const BinObjMgt_Persistent & | GetAsciiString (TCollection_AsciiString &theValue) const |
const BinObjMgt_Persistent & | operator>> (TCollection_AsciiString &theValue) const |
const BinObjMgt_Persistent & | GetExtendedString (TCollection_ExtendedString &theValue) const |
const BinObjMgt_Persistent & | operator>> (TCollection_ExtendedString &theValue) const |
const BinObjMgt_Persistent & | GetLabel (const Handle< TDF_Data > &theDS, TDF_Label &theValue) const |
const BinObjMgt_Persistent & | GetGUID (Standard_GUID &theValue) const |
const BinObjMgt_Persistent & | operator>> (Standard_GUID &theValue) const |
const BinObjMgt_Persistent & | GetCharArray (const BinObjMgt_PChar theArray, const Standard_Integer theLength) const |
Get C array of char, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
const BinObjMgt_Persistent & | GetByteArray (const BinObjMgt_PByte theArray, const Standard_Integer theLength) const |
Get C array of unsigned chars, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
const BinObjMgt_Persistent & | GetExtCharArray (const BinObjMgt_PExtChar theArray, const Standard_Integer theLength) const |
Get C array of ExtCharacter, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
const BinObjMgt_Persistent & | GetIntArray (const BinObjMgt_PInteger theArray, const Standard_Integer theLength) const |
Get C array of int, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
const BinObjMgt_Persistent & | GetRealArray (const BinObjMgt_PReal theArray, const Standard_Integer theLength) const |
Get C array of double, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
const BinObjMgt_Persistent & | GetShortRealArray (const BinObjMgt_PShortReal theArray, const Standard_Integer theLength) const |
Get C array of float, theLength is the number of elements; theArray must point to a space enough to place theLength elements. | |
Standard_Integer | Position () const |
Tells the current position for get/put. | |
Standard_Boolean | SetPosition (const Standard_Integer thePos) const |
Sets the current position for get/put. Resets an error state depending on the validity of thePos. Returns the new state (value of IsOK()) | |
void | Truncate () |
Truncates the buffer by current position, i.e. updates mySize. | |
Standard_Boolean | IsError () const |
Indicates an error after Get methods or SetPosition. | |
Standard_Boolean | operator! () const |
Standard_Boolean | IsOK () const |
Indicates a good state after Get methods or SetPosition. | |
operator Standard_Boolean () const | |
void | Init () |
Initializes me to reuse again. | |
void | SetId (const Standard_Integer theId) |
Sets the Id of the object. | |
void | SetTypeId (const Standard_Integer theId) |
Sets the Id of the type of the object. | |
Standard_Integer | Id () const |
Returns the Id of the object. | |
Standard_Integer | TypeId () const |
Returns the Id of the type of the object. | |
Standard_Integer | Length () const |
Returns the length of data. | |
Standard_OStream & | Write (Standard_OStream &theOS, const Standard_Boolean theDirectStream=Standard_False) |
Stores <me> to the stream. inline Standard_OStream& operator<< (Standard_OStream&, BinObjMgt_Persistent&) is also available. If theDirectStream is true, after this data the direct stream data is stored. | |
Standard_IStream & | Read (Standard_IStream &theIS) |
Retrieves <me> from the stream. inline Standard_IStream& operator>> (Standard_IStream&, BinObjMgt_Persistent&) is also available. | |
void | Destroy () |
Frees the allocated memory; This object can be reused after call to Init. | |
~BinObjMgt_Persistent () | |
void | SetOStream (Standard_OStream &theStream) |
Sets the stream for direct writing. | |
void | SetIStream (Standard_IStream &theStream) |
Sets the stream for direct reading. | |
Standard_OStream * | GetOStream () |
Gets the stream for and enables direct writing. | |
Standard_IStream * | GetIStream () |
Gets the stream for and enables direct reading. | |
Standard_Boolean | IsDirect () |
Returns true if after this record a direct writing to the stream is performed. | |
Handle< BinObjMgt_Position > | StreamStart () |
Returns the start position of the direct writing in the stream. | |
Binary persistent representation of an object. Really it is used as a buffer for read/write an object.
It takes care of Little/Big endian by inversing bytes in objects of standard types (see FSD_FileHeader.hxx for the default value of DO_INVERSE).
BinObjMgt_Persistent::BinObjMgt_Persistent | ( | ) |
Empty constructor.
|
inline |
void BinObjMgt_Persistent::Destroy | ( | ) |
Frees the allocated memory; This object can be reused after call to Init.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetAsciiString | ( | TCollection_AsciiString & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetBoolean | ( | Standard_Boolean & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetByte | ( | Standard_Byte & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetByteArray | ( | const BinObjMgt_PByte | theArray, |
const Standard_Integer | theLength ) const |
Get C array of unsigned chars, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetCharacter | ( | Standard_Character & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetCharArray | ( | const BinObjMgt_PChar | theArray, |
const Standard_Integer | theLength ) const |
Get C array of char, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetExtCharacter | ( | Standard_ExtCharacter & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetExtCharArray | ( | const BinObjMgt_PExtChar | theArray, |
const Standard_Integer | theLength ) const |
Get C array of ExtCharacter, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetExtendedString | ( | TCollection_ExtendedString & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetGUID | ( | Standard_GUID & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetIntArray | ( | const BinObjMgt_PInteger | theArray, |
const Standard_Integer | theLength ) const |
Get C array of int, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetInteger | ( | Standard_Integer & | theValue | ) | const |
Standard_IStream * BinObjMgt_Persistent::GetIStream | ( | ) |
Gets the stream for and enables direct reading.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetLabel | ( | const Handle< TDF_Data > & | theDS, |
TDF_Label & | theValue ) const |
Standard_OStream * BinObjMgt_Persistent::GetOStream | ( | ) |
Gets the stream for and enables direct writing.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetReal | ( | Standard_Real & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetRealArray | ( | const BinObjMgt_PReal | theArray, |
const Standard_Integer | theLength ) const |
Get C array of double, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetShortReal | ( | Standard_ShortReal & | theValue | ) | const |
const BinObjMgt_Persistent & BinObjMgt_Persistent::GetShortRealArray | ( | const BinObjMgt_PShortReal | theArray, |
const Standard_Integer | theLength ) const |
Get C array of float, theLength is the number of elements; theArray must point to a space enough to place theLength elements.
Standard_Integer BinObjMgt_Persistent::Id | ( | ) | const |
Returns the Id of the object.
void BinObjMgt_Persistent::Init | ( | ) |
Initializes me to reuse again.
|
inline |
Returns true if after this record a direct writing to the stream is performed.
Standard_Boolean BinObjMgt_Persistent::IsError | ( | ) | const |
Indicates an error after Get methods or SetPosition.
Standard_Boolean BinObjMgt_Persistent::IsOK | ( | ) | const |
Indicates a good state after Get methods or SetPosition.
Standard_Integer BinObjMgt_Persistent::Length | ( | ) | const |
Returns the length of data.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Standard_Integer BinObjMgt_Persistent::Position | ( | ) | const |
Tells the current position for get/put.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutAsciiString | ( | const TCollection_AsciiString & | theValue | ) |
Offset in output buffer is word-aligned.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutBoolean | ( | const Standard_Boolean | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutByte | ( | const Standard_Byte | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutByteArray | ( | const BinObjMgt_PByte | theArray, |
const Standard_Integer | theLength ) |
Put C array of unsigned chars, theLength is the number of elements.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutCharacter | ( | const Standard_Character | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutCharArray | ( | const BinObjMgt_PChar | theArray, |
const Standard_Integer | theLength ) |
Put C array of char, theLength is the number of elements.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutCString | ( | const Standard_CString | theValue | ) |
Offset in output buffer is not aligned.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutExtCharacter | ( | const Standard_ExtCharacter | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutExtCharArray | ( | const BinObjMgt_PExtChar | theArray, |
const Standard_Integer | theLength ) |
Put C array of ExtCharacter, theLength is the number of elements.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutExtendedString | ( | const TCollection_ExtendedString & | theValue | ) |
Offset in output buffer is word-aligned.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutGUID | ( | const Standard_GUID & | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutIntArray | ( | const BinObjMgt_PInteger | theArray, |
const Standard_Integer | theLength ) |
Put C array of int, theLength is the number of elements.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutInteger | ( | const Standard_Integer | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutLabel | ( | const TDF_Label & | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutReal | ( | const Standard_Real | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutRealArray | ( | const BinObjMgt_PReal | theArray, |
const Standard_Integer | theLength ) |
Put C array of double, theLength is the number of elements.
BinObjMgt_Persistent & BinObjMgt_Persistent::PutShortReal | ( | const Standard_ShortReal | theValue | ) |
BinObjMgt_Persistent & BinObjMgt_Persistent::PutShortRealArray | ( | const BinObjMgt_PShortReal | theArray, |
const Standard_Integer | theLength ) |
Put C array of float, theLength is the number of elements.
Standard_IStream & BinObjMgt_Persistent::Read | ( | Standard_IStream & | theIS | ) |
Retrieves <me> from the stream. inline Standard_IStream& operator>> (Standard_IStream&, BinObjMgt_Persistent&) is also available.
void BinObjMgt_Persistent::SetId | ( | const Standard_Integer | theId | ) |
Sets the Id of the object.
|
inline |
Sets the stream for direct reading.
|
inline |
Sets the stream for direct writing.
Standard_Boolean BinObjMgt_Persistent::SetPosition | ( | const Standard_Integer | thePos | ) | const |
Sets the current position for get/put. Resets an error state depending on the validity of thePos. Returns the new state (value of IsOK())
void BinObjMgt_Persistent::SetTypeId | ( | const Standard_Integer | theId | ) |
Sets the Id of the type of the object.
|
inline |
Returns the start position of the direct writing in the stream.
void BinObjMgt_Persistent::Truncate | ( | ) |
Truncates the buffer by current position, i.e. updates mySize.
Standard_Integer BinObjMgt_Persistent::TypeId | ( | ) | const |
Returns the Id of the type of the object.
Standard_OStream & BinObjMgt_Persistent::Write | ( | Standard_OStream & | theOS, |
const Standard_Boolean | theDirectStream = Standard_False ) |
Stores <me> to the stream. inline Standard_OStream& operator<< (Standard_OStream&, BinObjMgt_Persistent&) is also available. If theDirectStream is true, after this data the direct stream data is stored.