CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdTfFiler Struct Referenceabstract

#include <Tf.h>

Public Member Functions

virtual OdRxObject * database () const =0
 
virtual void seek (OdInt64 offset, OdDb::FilerSeekType seekType)=0
 
virtual OdUInt64 tell () const =0
 
virtual bool rdBool ()=0
 
virtual OdString rdString ()=0
 
virtual void rdBytes (void *buffer, OdUInt32 numBytes)=0
 
virtual OdInt8 rdInt8 ()=0
 
virtual OdUInt8 rdUInt8 ()=0
 
virtual OdInt16 rdInt16 ()=0
 
virtual OdInt32 rdInt32 ()=0
 
virtual OdInt64 rdInt64 ()=0
 
virtual double rdDouble ()=0
 
virtual OdDbHandle rdDbHandle ()=0
 
virtual OdDbStub * rdSoftOwnershipId ()=0
 
virtual OdDbStub * rdHardOwnershipId ()=0
 
virtual OdDbStub * rdHardPointerId ()=0
 
virtual OdDbStub * rdSoftPointerId ()=0
 
virtual OdGePoint2d rdPoint2d ()=0
 
virtual OdGePoint3d rdPoint3d ()=0
 
virtual OdGeVector2d rdVector2d ()=0
 
virtual OdGeVector3d rdVector3d ()=0
 
virtual OdGeScale3d rdScale3d ()=0
 
virtual void wrBool (bool value)=0
 
virtual void wrString (const OdString &value)=0
 
virtual void wrBytes (const void *buffer, OdUInt32 numBytes)=0
 
virtual void wrInt8 (OdInt8 value)=0
 
virtual void wrUInt8 (OdUInt8 value)=0
 
virtual void wrInt16 (OdInt16 value)=0
 
virtual void wrInt32 (OdInt32 value)=0
 
virtual void wrInt64 (OdInt64 value)=0
 
virtual void wrDouble (double value)=0
 
virtual void wrDbHandle (const OdDbHandle &value)=0
 
virtual void wrSoftOwnershipId (OdDbStub *value)=0
 
virtual void wrHardOwnershipId (OdDbStub *value)=0
 
virtual void wrSoftPointerId (OdDbStub *value)=0
 
virtual void wrHardPointerId (OdDbStub *value)=0
 
virtual void wrPoint2d (const OdGePoint2d &value)=0
 
virtual void wrPoint3d (const OdGePoint3d &value)=0
 
virtual void wrVector2d (const OdGeVector2d &value)=0
 
virtual void wrVector3d (const OdGeVector3d &value)=0
 
virtual void wrScale3d (const OdGeScale3d &value)=0
 
virtual void wrSubobject (int id, const char *name)=0
 
virtual const char * rdSubobject (int &id)=0
 
virtual void wrDateTime (OdTimeStamp)=0
 
virtual void rdDateTime (OdTimeStamp &)=0
 

Detailed Description

This structure is the base for structures that are used for file I/O operations with revision control database.

Definition at line 49 of file Tf.h.

Member Function Documentation

◆ database()

virtual OdRxObject * OdTfFiler::database ( ) const
pure virtual

Returns the database associated with this Filer object.

◆ rdBool()

virtual bool OdTfFiler::rdBool ( )
pure virtual

Reads the boolean value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read boolean value.

◆ rdBytes()

virtual void OdTfFiler::rdBytes ( void *  buffer,
OdUInt32  numBytes 
)
pure virtual

Reads the specified number of bytes, starting from the current position of the file pointer for this Filer object, and increments the pointer by numBytes.

Parameters
buffer[out] Read bytes buffer.
numBytes[in] Number of bytes.

◆ rdDateTime()

virtual void OdTfFiler::rdDateTime ( OdTimeStamp &  )
pure virtual

Reads the TimeStamp value from the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[out] Read value.

◆ rdDbHandle()

virtual OdDbHandle OdTfFiler::rdDbHandle ( )
pure virtual

Reads the DbHandle value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read DbHandle value.

◆ rdDouble()

virtual double OdTfFiler::rdDouble ( )
pure virtual

Reads the Double value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Double value.

◆ rdHardOwnershipId()

virtual OdDbStub * OdTfFiler::rdHardOwnershipId ( )
pure virtual

Reads the HardOwnershipId value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read HardOwnershipId value.

◆ rdHardPointerId()

virtual OdDbStub * OdTfFiler::rdHardPointerId ( )
pure virtual

Reads the HardPointerId value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read HardPointerId value.

◆ rdInt16()

virtual OdInt16 OdTfFiler::rdInt16 ( )
pure virtual

Reads the Int16 value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Int16 value.

◆ rdInt32()

virtual OdInt32 OdTfFiler::rdInt32 ( )
pure virtual

Reads the Int32 value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Int32 value.

◆ rdInt64()

virtual OdInt64 OdTfFiler::rdInt64 ( )
pure virtual

Reads the Int64 value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Int64 value.

◆ rdInt8()

virtual OdInt8 OdTfFiler::rdInt8 ( )
pure virtual

Reads the Int8 value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Int8 value.

◆ rdPoint2d()

virtual OdGePoint2d OdTfFiler::rdPoint2d ( )
pure virtual

Reads the Point2d value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Point2d value.

◆ rdPoint3d()

virtual OdGePoint3d OdTfFiler::rdPoint3d ( )
pure virtual

Reads the Point3d value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Point3d value.

◆ rdScale3d()

virtual OdGeScale3d OdTfFiler::rdScale3d ( )
pure virtual

Reads the Scale3d value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Scale3d value.

◆ rdSoftOwnershipId()

virtual OdDbStub * OdTfFiler::rdSoftOwnershipId ( )
pure virtual

Reads the OwnershipId value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read OwnershipId value.

◆ rdSoftPointerId()

virtual OdDbStub * OdTfFiler::rdSoftPointerId ( )
pure virtual

Reads the SoftPointerId value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read SoftPointerId value.

◆ rdString()

virtual OdString OdTfFiler::rdString ( )
pure virtual

Reads the String value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read String value.

◆ rdSubobject()

virtual const char * OdTfFiler::rdSubobject ( int &  id)
pure virtual

Reads the specified Subobject data from the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
id[in] Subobject ID.
Returns
Subobject name.

◆ rdUInt8()

virtual OdUInt8 OdTfFiler::rdUInt8 ( )
pure virtual

Reads the UInt8 value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read UInt8 value.

◆ rdVector2d()

virtual OdGeVector2d OdTfFiler::rdVector2d ( )
pure virtual

Reads the Vector2d value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Vector2d value.

◆ rdVector3d()

virtual OdGeVector3d OdTfFiler::rdVector3d ( )
pure virtual

Reads the Vector3d value from the current position of the file pointer for this Filer object, and increments the pointer.

Returns
Read Vector3d value.

◆ seek()

virtual void OdTfFiler::seek ( OdInt64  offset,
OdDb::FilerSeekType  seekType 
)
pure virtual

Moves the current position of the file pointer for this Filer object to the specified location.

Parameters
offset[in] Number of bytes.
seekType[in] Seek type.
Remarks
seekType value must be one of the following:

Value Description. OdDb::kSeekFromStart SEEK_SET Start of file. OdDb::kSeekFromCurrent SEEK_CUR Current position of file pointer. OdDb::kSeekFromEnd SEEK_END End of file.

◆ tell()

virtual OdUInt64 OdTfFiler::tell ( ) const
pure virtual

Returns the current I/O pointer position of this Filer object.

◆ wrBool()

virtual void OdTfFiler::wrBool ( bool  value)
pure virtual

Writes the specified boolean value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrBytes()

virtual void OdTfFiler::wrBytes ( const void *  buffer,
OdUInt32  numBytes 
)
pure virtual

Writes the specified number of bytes, starting from the current position of the file pointer for this Filer object, and increments the pointer by numBytes.

Parameters
buffer[in] Array of bytes to write.
numBytes[in] Number of bytes.

◆ wrDateTime()

virtual void OdTfFiler::wrDateTime ( OdTimeStamp  )
pure virtual

Writes the specified TimeStamp value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrDbHandle()

virtual void OdTfFiler::wrDbHandle ( const OdDbHandle &  value)
pure virtual

Writes the specified DbHandle value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrDouble()

virtual void OdTfFiler::wrDouble ( double  value)
pure virtual

Writes the specified Double value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrHardOwnershipId()

virtual void OdTfFiler::wrHardOwnershipId ( OdDbStub *  value)
pure virtual

Writes the specified HardOwnershipId value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrHardPointerId()

virtual void OdTfFiler::wrHardPointerId ( OdDbStub *  value)
pure virtual

Writes the specified HardPointerId value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrInt16()

virtual void OdTfFiler::wrInt16 ( OdInt16  value)
pure virtual

Writes the specified Int16 value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrInt32()

virtual void OdTfFiler::wrInt32 ( OdInt32  value)
pure virtual

Writes the specified Int32 value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrInt64()

virtual void OdTfFiler::wrInt64 ( OdInt64  value)
pure virtual

Writes the specified Int64 value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrInt8()

virtual void OdTfFiler::wrInt8 ( OdInt8  value)
pure virtual

Writes the specified Int8 value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrPoint2d()

virtual void OdTfFiler::wrPoint2d ( const OdGePoint2d &  value)
pure virtual

Writes the specified Point2d value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrPoint3d()

virtual void OdTfFiler::wrPoint3d ( const OdGePoint3d &  value)
pure virtual

Writes the specified Point3d value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrScale3d()

virtual void OdTfFiler::wrScale3d ( const OdGeScale3d &  value)
pure virtual

Writes the specified Scale3d value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrSoftOwnershipId()

virtual void OdTfFiler::wrSoftOwnershipId ( OdDbStub *  value)
pure virtual

Writes the specified SoftOwnershipId value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrSoftPointerId()

virtual void OdTfFiler::wrSoftPointerId ( OdDbStub *  value)
pure virtual

Writes the specified SoftPointerId value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrString()

virtual void OdTfFiler::wrString ( const OdString &  value)
pure virtual

Writes the specified String value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrSubobject()

virtual void OdTfFiler::wrSubobject ( int  id,
const char *  name 
)
pure virtual

Writes the specified Subobject data at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
id[in] Subobject ID.
name[in] Subobject name.

◆ wrUInt8()

virtual void OdTfFiler::wrUInt8 ( OdUInt8  value)
pure virtual

Writes the specified UInt8 value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrVector2d()

virtual void OdTfFiler::wrVector2d ( const OdGeVector2d &  value)
pure virtual

Writes the specified Vector2d value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.

◆ wrVector3d()

virtual void OdTfFiler::wrVector3d ( const OdGeVector3d &  value)
pure virtual

Writes the specified Vector3d value at the current position of the file pointer for this Filer object, and increments the pointer.

Parameters
value[in] Value to write.
The documentation for this struct was generated from the following file:
Generated on Wed Apr 5 2023 17:31:33