CFx SDK Documentation  2020SP3
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdResBuf Class Reference

#include <ResBuf.h>

Inheritance diagram for OdResBuf:
OdRxObject

Classes

union  Data
 

Public Types

enum  ValueType {
  kRtNorm = 5100, kRtMemErr = -5000, kRtError = -5001, kRtCan = -5002,
  kRtRej = -5003, kRtFail = -5004, kRtKword = -5005, kRtInputTruncated = -5008,
  kRtNone = 5000, kRtDouble = 5001, kRtPoint2d = 5002, kRtInt16 = 5003,
  kRtAngle = 5004, kRtString = 5005, kRtEntName = 5006, kRtPickSet = 5007,
  kRtOrient = 5008, kRtPoint3d = 5009, kRtInt32 = 5010, kRtColor = 5011,
  kRtVoid = 5014, kRtListBeg = 5016, kRtListEnd = 5017, kRtDote = 5018,
  kRtNil = 5019, kRtDXF0 = 5020, kRtT = 5021, kRtResBuf = 5023,
  kRtBool = 290, kRtInt8 = 280, kRtVector2d = kRtPoint2d, kRtVector3d = kRtPoint3d,
  kRtBinaryChunk = 310, kRtHandle = 320, kRtObjectId = 330, kRtSoftPointerId = 330,
  kRtHardPointerId = 340, kRtSoftOwnershipId = 350, kRtHardOwnershipId = 360, kDxfInvalid = -9999,
  kDxfXDictionary = -6, kDxfPReactors = -5, kDxfOperator = -4, kDxfXDataStart = -3,
  kDxfHeaderId = -2, kDxfFirstEntId = -2, kDxfEnd = -1, kDxfStart = 0,
  kDxfText = 1, kDxfXRefPath = 1, kDxfShapeName = 2, kDxfBlockName = 2,
  kDxfAttributeTag = 2, kDxfSymbolTableName = 2, kDxfMstyleName = 2, kDxfSymTableRecName = 2,
  kDxfAttributePrompt = 3, kDxfDimStyleName = 3, kDxfLinetypeProse = 3, kDxfTextFontFile = 3,
  kDxfDescription = 3, kDxfDimPostStr = 3, kDxfTextBigFontFile = 4, kDxfDimAPostStr = 4,
  kDxfCLShapeName = 4, kDxfSymTableRecComments = 4, kDxfHandle = 5, kDxfDimBlk = 5,
  kDxfDimBlk1 = 6, kDxfLinetypeName = 6, kDxfDimBlk2 = 7, kDxfTextStyleName = 7,
  kDxfLayerName = 8, kDxfCLShapeText = 9, kDxfXCoord = 10, kDxfYCoord = 20,
  kDxfZCoord = 30, kDxfElevation = 38, kDxfThickness = 39, kDxfReal = 40,
  kDxfViewportHeight = 40, kDxfTxtSize = 40, kDxfTxtStyleXScale = 41, kDxfViewWidth = 41,
  kDxfViewportAspect = 41, kDxfTxtStylePSize = 42, kDxfViewLensLength = 42, kDxfViewFrontClip = 43,
  kDxfViewBackClip = 44, kDxfShapeXOffset = 44, kDxfShapeYOffset = 45, kDxfViewHeight = 45,
  kDxfShapeScale = 46, kDxfPixelScale = 47, kDxfLinetypeScale = 48, kDxfDashLength = 49,
  kDxfMlineOffset = 49, kDxfLinetypeElement = 49, kDxfAngle = 50, kDxfViewportSnapAngle = 50,
  kDxfViewportTwist = 51, kDxfVisibility = 60, kDxfLayerLinetype = 61, kDxfColor = 62,
  kDxfHasSubentities = 66, kDxfViewportVisibility = 67, kDxfViewportActive = 68, kDxfViewportNumber = 69,
  kDxfInt16 = 70, kDxfViewMode = 71, kDxfCircleSides = 72, kDxfViewportZoom = 73,
  kDxfViewportIcon = 74, kDxfViewportSnap = 75, kDxfViewportGrid = 76, kDxfViewportSnapStyle = 77,
  kDxfViewportSnapPair = 78, kDxfRegAppFlags = 71, kDxfTxtStyleFlags = 71, kDxfLinetypeAlign = 72,
  kDxfLinetypePDC = 73, kDxfInt32 = 90, kDxfSubclass = 100, kDxfEmbeddedObjectStart = 101,
  kDxfControlString = 102, kDxfDimVarHandle = 105, kDxfUCSOrg = 110, kDxfUCSOriX = 111,
  kDxfUCSOriY = 112, kDxfXReal = 140, kDxfInt64 = 160, kDxfXInt16 = 170,
  kDxfNormalX = 210, kDxfNormalY = 220, kDxfNormalZ = 230, kDxfXXInt16 = 270,
  kDxfInt8 = 280, kDxfRenderMode = 281, kDxfBool = 290, kDxfXTextString = 300,
  kDxfBinaryChunk = 310, kDxfArbHandle = 320, kDxfSoftPointerId = 330, kDxfHardPointerId = 340,
  kDxfSoftOwnershipId = 350, kDxfHardOwnershipId = 360, kDxfLineWeight = 370, kDxfPlotStyleNameType = 380,
  kDxfPlotStyleNameId = 390, kDxfXXXInt16 = 400, kDxfLayoutName = 410, kDxfComment = 999,
  kDxfXdAsciiString = 1000, kDxfRegAppName = 1001, kDxfXdControlString = 1002, kDxfXdLayerName = 1003,
  kDxfXdBinaryChunk = 1004, kDxfXdHandle = 1005, kDxfXdXCoord = 1010, kDxfXdYCoord = 1020,
  kDxfXdZCoord = 1030, kDxfXdWorldXCoord = 1011, kDxfXdWorldYCoord = 1021, kDxfXdWorldZCoord = 1031,
  kDxfXdWorldXDisp = 1012, kDxfXdWorldYDisp = 1022, kDxfXdWorldZDisp = 1032, kDxfXdWorldXDir = 1013,
  kDxfXdWorldYDir = 1023, kDxfXdWorldZDir = 1033, kDxfXdReal = 1040, kDxfXdDist = 1041,
  kDxfXdScale = 1042, kDxfXdInteger16 = 1070, kDxfXdInteger32 = 1071
}
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdResBuf)
 
 ~OdResBuf ()
 
void copyFrom (const OdRxObject *pRb)
 
bool operator== (const OdResBuf &Rb) const
 
bool operator!= (const OdResBuf &Rb) const
 
int restype () const
 
void setRestype (int resType)
 
OdResBufPtr next () const
 
OdResBufPtr last () const
 
OdResBufPtr insert (OdResBuf *pRb)
 
OdResBufPtr setNext (OdResBuf *pRb)
 
OdString getString () const
 
void setString (const OdString &sValue)
 
bool getBool () const
 
void setBool (bool bValue)
 
OdInt8 getInt8 () const
 
void setInt8 (OdInt8 iValue)
 
OdInt16 getInt16 () const
 
void setInt16 (OdInt16 iValue)
 
OdInt32 getInt32 () const
 
void setInt32 (OdInt32 iValue)
 
OdInt64 getInt64 () const
 
void setInt64 (OdInt64 iValue)
 
double getDouble () const
 
void setDouble (double realValue)
 
const OdGePoint2d & getPoint2d () const
 
void setPoint2d (const OdGePoint2d &gePoint)
 
const OdGePoint3d & getPoint3d () const
 
void setPoint3d (const OdGePoint3d &gePoint)
 
const OdGeVector2d & getVector2d () const
 
void setVector2d (const OdGeVector2d &geVector)
 
const OdGeVector3d & getVector3d () const
 
void setVector3d (const OdGeVector3d &val)
 
const OdBinaryData & getBinaryChunk () const
 
void setBinaryChunk (const OdBinaryData &bChunk)
 
const OdCmColor & getColor () const
 
void setColor (const OdCmColor &cmColor)
 
OdResBufPtr getResBuf () const
 
void setResBuf (const OdResBuf *pResBuf)
 
OdDbHandle getHandle () const
 
void setHandle (const OdDbHandle &vHandle)
 
const OdDbObjectId & getEntName () const
 
void setObjectId (const OdDbObjectId &idObject)
 
OdDbObjectId getObjectId (const OdDbDatabase *pDb) const
 
OdDbSelectionSetPtr getPickSet () const
 
void setPickSet (const OdDbSelectionSet *pSSet)
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdResBufPtr newRb (int resType=OdResBuf::kRtNone)
 
static OdResBufPtr newRb (int resType, bool resVal)
 
static OdResBufPtr newRb (int resType, OdInt8 resVal)
 
static OdResBufPtr newRb (int resType, OdUInt8 resVal)
 
static OdResBufPtr newRb (int resType, OdInt16 resVal)
 
static OdResBufPtr newRb (int resType, OdUInt16 resVal)
 
static OdResBufPtr newRb (int resType, OdInt32 resVal)
 
static OdResBufPtr newRb (int resType, OdUInt32 resVal)
 
static OdResBufPtr newRb (int resType, OdInt64 resVal)
 
static OdResBufPtr newRb (int resType, OdUInt64 resVal)
 
static OdResBufPtr newRb (int resType, double resVal)
 
static OdResBufPtr newRb (int resType, const OdGePoint2d &resVal)
 
static OdResBufPtr newRb (int resType, const OdGePoint3d &resVal)
 
static OdResBufPtr newRb (int resType, const OdGeVector2d &resVal)
 
static OdResBufPtr newRb (int resType, const OdGeVector3d &resVal)
 
static OdResBufPtr newRb (int resType, const OdString &resVal)
 
static OdResBufPtr newRb (int resType, const OdChar *resVal)
 
static OdResBufPtr newRb (int resType, const OdCmColor &resVal)
 
static OdResBufPtr newRb (int resType, const OdDbObjectId &id)
 
static OdResBufPtr newRb (int resType, const OdDbSelectionSet *pSSet)
 
static OdResBufPtr newRb (int resType, const OdResBuf *pNestedRb)
 
static void setAssertIndexByNewRb (int index)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Protected Member Functions

 OdResBuf ()
 

Protected Attributes

int m_nCode
 
Data m_data
 
OdResBufPtr m_pNext
 

Detailed Description

<group Other_Classes>

This class implements ResBuf object which represents the structure for storing and passing the tagged data of all basic data types between various objects using different technologies.

Remarks
Each ResBuf object contains three data members: ResType: An integer which specifies the type of data stored in the ResBuf instance. ResVal: A container for the data stored in the ResBuf instance. RbNext: A smart pointer to the ResBuf instance to be attached in a linked list.
See also
TD_Db
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>

<link db_rb_sample_sequence.html, Example of Working with the Sequence of Tagged Data>

See also
<link db_rb.html, Working with Tagged Data>

<link db_xdata.html, Working with Extended Data>

<link db_sysvar.html, Working with System Variables>

Definition at line 111 of file ResBuf.h.

Member Enumeration Documentation

◆ ValueType

enum OdResBuf::ValueType

Defines the group codes for ResBuf instances.

Enumerator
kRtNorm 
kRtMemErr 
kRtError 
kRtCan 
kRtRej 
kRtFail 
kRtKword 
kRtInputTruncated 
kRtNone 
kRtDouble 
kRtPoint2d 
kRtInt16 
kRtAngle 
kRtString 
kRtEntName 
kRtPickSet 
kRtOrient 
kRtPoint3d 
kRtInt32 
kRtColor 
kRtVoid 
kRtListBeg 
kRtListEnd 
kRtDote 
kRtNil 
kRtDXF0 
kRtT 
kRtResBuf 
kRtBool 
kRtInt8 
kRtVector2d 
kRtVector3d 
kRtBinaryChunk 
kRtHandle 
kRtObjectId 
kRtSoftPointerId 
kRtHardPointerId 
kRtSoftOwnershipId 
kRtHardOwnershipId 
kDxfInvalid 
kDxfXDictionary 
kDxfPReactors 
kDxfOperator 
kDxfXDataStart 
kDxfHeaderId 
kDxfFirstEntId 
kDxfEnd 
kDxfStart 
kDxfText 
kDxfXRefPath 
kDxfShapeName 
kDxfBlockName 
kDxfAttributeTag 
kDxfSymbolTableName 
kDxfMstyleName 
kDxfSymTableRecName 
kDxfAttributePrompt 
kDxfDimStyleName 
kDxfLinetypeProse 
kDxfTextFontFile 
kDxfDescription 
kDxfDimPostStr 
kDxfTextBigFontFile 
kDxfDimAPostStr 
kDxfCLShapeName 
kDxfSymTableRecComments 
kDxfHandle 
kDxfDimBlk 
kDxfDimBlk1 
kDxfLinetypeName 
kDxfDimBlk2 
kDxfTextStyleName 
kDxfLayerName 
kDxfCLShapeText 
kDxfXCoord 
kDxfYCoord 
kDxfZCoord 
kDxfElevation 
kDxfThickness 
kDxfReal 
kDxfViewportHeight 
kDxfTxtSize 
kDxfTxtStyleXScale 
kDxfViewWidth 
kDxfViewportAspect 
kDxfTxtStylePSize 
kDxfViewLensLength 
kDxfViewFrontClip 
kDxfViewBackClip 
kDxfShapeXOffset 
kDxfShapeYOffset 
kDxfViewHeight 
kDxfShapeScale 
kDxfPixelScale 
kDxfLinetypeScale 
kDxfDashLength 
kDxfMlineOffset 
kDxfLinetypeElement 
kDxfAngle 
kDxfViewportSnapAngle 
kDxfViewportTwist 
kDxfVisibility 
kDxfLayerLinetype 
kDxfColor 
kDxfHasSubentities 
kDxfViewportVisibility 
kDxfViewportActive 
kDxfViewportNumber 
kDxfInt16 
kDxfViewMode 
kDxfCircleSides 
kDxfViewportZoom 
kDxfViewportIcon 
kDxfViewportSnap 
kDxfViewportGrid 
kDxfViewportSnapStyle 
kDxfViewportSnapPair 
kDxfRegAppFlags 
kDxfTxtStyleFlags 
kDxfLinetypeAlign 
kDxfLinetypePDC 
kDxfInt32 
kDxfSubclass 
kDxfEmbeddedObjectStart 
kDxfControlString 
kDxfDimVarHandle 
kDxfUCSOrg 
kDxfUCSOriX 
kDxfUCSOriY 
kDxfXReal 
kDxfInt64 
kDxfXInt16 
kDxfNormalX 
kDxfNormalY 
kDxfNormalZ 
kDxfXXInt16 
kDxfInt8 
kDxfRenderMode 
kDxfBool 
kDxfXTextString 
kDxfBinaryChunk 
kDxfArbHandle 
kDxfSoftPointerId 
kDxfHardPointerId 
kDxfSoftOwnershipId 
kDxfHardOwnershipId 
kDxfLineWeight 
kDxfPlotStyleNameType 
kDxfPlotStyleNameId 
kDxfXXXInt16 
kDxfLayoutName 
kDxfComment 
kDxfXdAsciiString 
kDxfRegAppName 
kDxfXdControlString 
kDxfXdLayerName 
kDxfXdBinaryChunk 
kDxfXdHandle 
kDxfXdXCoord 
kDxfXdYCoord 
kDxfXdZCoord 
kDxfXdWorldXCoord 
kDxfXdWorldYCoord 
kDxfXdWorldZCoord 
kDxfXdWorldXDisp 
kDxfXdWorldYDisp 
kDxfXdWorldZDisp 
kDxfXdWorldXDir 
kDxfXdWorldYDir 
kDxfXdWorldZDir 
kDxfXdReal 
kDxfXdDist 
kDxfXdScale 
kDxfXdInteger16 
kDxfXdInteger32 

Definition at line 170 of file ResBuf.h.

Constructor & Destructor Documentation

◆ ~OdResBuf()

OdResBuf::~OdResBuf ( )

Destroys an instance of the ResBuf object.

◆ OdResBuf()

OdResBuf::OdResBuf ( )
protected

Builds an instance of the ResBuf object.

Remarks
Use the newRb() static pseudo-constructor instead it. See: <link db_rb_sequence.html, Sequence of Tagged Data>

Member Function Documentation

◆ copyFrom()

void OdResBuf::copyFrom ( const OdRxObject *  pRb)
virtual

Copies the contents of the specified ResBuf object into this ResBuf object.

Parameters
pRb[in] Pointer to the specified source ResBuf object to be copied.
Remarks
This method generates the eInvalidGroupCode exeption when the data types of both ResBuf object are diffenrent or specified ResBuf value is invalid.
See also
<link db_rb.html, Working with Tagged Data>

Reimplemented from OdRxObject.

◆ getBinaryChunk()

const OdBinaryData& OdResBuf::getBinaryChunk ( ) const

Returns the data content of the ResBuf object as a Binary chunk.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the BinaryChunk type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setBinaryChunk(), OdResBuf::restype(), OdDxfCode::_getType() methods

OdBinaryData, OdUInt8 classes

◆ getBool()

bool OdResBuf::getBool ( ) const

Returns the data content of the ResBuf object as a Boolean value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Bool type. If the stored value is an Integer type, this method casts it to a Boolean type and returns True when the value is non zero, or False when the value is zero.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setBool(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getColor()

const OdCmColor& OdResBuf::getColor ( ) const

Returns the data content of the ResBuf object as a Color instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored group code is not set to kRtColor. The OdDxfCode::_getType() method returns Unknown type for it.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

<link cm.html, Colors and Transparencies>

OdResBuf::setColor(), OdResBuf::restype() methods

◆ getDouble()

double OdResBuf::getDouble ( ) const

Returns the data content of the ResBuf object as a double-precision floating-point value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Double or Angle type. The returned value can be converted to an Integer value truncating the fractional part.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setDouble(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getEntName()

const OdDbObjectId& OdResBuf::getEntName ( ) const

Returns the data content of the ResBuf object as an OdDbObjectId instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the ObjectId type. Only group codes kRtEntName and kDxfEnd store the object ID, other group codes associated with ObjectId, SoftPointerId, HardPointerId, SoftOwnershipId, HardOwnershipId types store the handle.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setObjectId(), OdResBuf::restype(), OdDxfCode::_getType() methods

OdDbObjectId, OdDbHandle classes

◆ getHandle()

OdDbHandle OdResBuf::getHandle ( ) const

Returns the data content of the ResBuf object as an OdDbHandle instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Handle type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setHandle(), OdResBuf::restype(), OdDxfCode::_getType() methods

OdDbHandle, OdUInt64 classes

◆ getInt16()

OdInt16 OdResBuf::getInt16 ( ) const

Returns the data content of the ResBuf object as 16-bit Integer value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer8 or Integer16 type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setInt16(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getInt32()

OdInt32 OdResBuf::getInt32 ( ) const

Returns the data content of the ResBuf object as 32-bit Integer value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer8, Integer16, or Integer32 type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setInt32(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getInt64()

OdInt64 OdResBuf::getInt64 ( ) const

Returns the data content of the ResBuf object as 64-bit Integer value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer8, Integer16, Integer32, or Integer64 type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setInt64(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getInt8()

OdInt8 OdResBuf::getInt8 ( ) const

Returns the data content of the ResBuf object as 8-bit Integer value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer8 or Integer16 type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setInt8(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getObjectId()

OdDbObjectId OdResBuf::getObjectId ( const OdDbDatabase *  pDb) const

Returns the data content of the ResBuf object as an OdDbObjectId instance using the specified database instance.

Parameters
pDb[in] Pointer to the database object.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

OdResBuf::setObjectId(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getPickSet()

OdDbSelectionSetPtr OdResBuf::getPickSet ( ) const

Returns the ResVal in this ResBuf object.

◆ getPoint2d()

const OdGePoint2d& OdResBuf::getPoint2d ( ) const

Returns the data content of the ResBuf object as two-dimesional point instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. When the ResBuf object stores three-dimensional point or vector, this method converts it to the two-dimesional point truncating Z-coordinate.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setPoint2d(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getPoint3d()

const OdGePoint3d& OdResBuf::getPoint3d ( ) const

Returns the data content of the ResBuf object as three-dimesional point instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. When the ResBuf object stores two-dimensional point or vector, this method converts it to the three-dimesional point adding zero Z-coordinate.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setPoint3d(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getResBuf()

OdResBufPtr OdResBuf::getResBuf ( ) const

Returns a pointer to the ResBuf instance nested in the data content of the ResBuf object.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored group code is not set to kRtResBuf. The OdDxfCode::_getType() method returns Unknown type for it.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

OdResBuf::setResBuf(), OdResBuf::restype() methods

◆ getString()

OdString OdResBuf::getString ( ) const

Returns the data content of the ResBuf object as a String value.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the String type or Name type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_string.html, Getting and Setting Strings>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setString(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getVector2d()

const OdGeVector2d& OdResBuf::getVector2d ( ) const

Returns the data content of the ResBuf object as two-dimesional vector instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. When the ResBuf object stores three-dimensional point or vector, this method converts it to the two-dimesional vector truncating Z-coordinate.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setVector2d(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ getVector3d()

const OdGeVector3d& OdResBuf::getVector3d ( ) const

Returns the data content of the ResBuf object as three-dimesional vector instance.

Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. When the ResBuf object stores two-dimensional point or vector, this method converts it to the three-dimesional vector adding zero Z-coordinate.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::setVector3d(), OdResBuf::restype(), OdDxfCode::_getType() methods

◆ insert()

OdResBufPtr OdResBuf::insert ( OdResBuf *  pRb)

Inserts the specified ResBuf object before the next ResBuf object in the sequence of tagged data after the current ResBuf object that calls this method.

Parameters
pRb[in] Pointer to the existing ResBuf instance to be inserted.
Returns
Returns a smart pointer to the ResBuf object before which it was inserted.
See also
<link db_rb_sample_sequence.html, Example of Working with the Sequence of Tagged Data>
<link db_rb_sequence.html, Sequence of Tagged Data>

OdResBuf::next(), OdResBuf::last(), OdResBuf::setNext() methods

◆ last()

OdResBufPtr OdResBuf::last ( ) const

Returns a smart pointer to the last ResBuf object in the sequence of tagged data.

See also
<link db_rb_sample_sequence.html, Example of Working with the Sequence of Tagged Data>
<link db_rb_sequence.html, Sequence of Tagged Data>

OdResBuf::next(), OdResBuf::setNext() methods

◆ newRb() [1/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
bool  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1265 of file ResBuf.h.

◆ newRb() [2/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdChar *  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1625 of file ResBuf.h.

◆ newRb() [3/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdCmColor &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1675 of file ResBuf.h.

◆ newRb() [4/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdDbObjectId &  id 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1699 of file ResBuf.h.

◆ newRb() [5/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdDbSelectionSet *  pSSet 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1723 of file ResBuf.h.

◆ newRb() [6/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdGePoint2d &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1505 of file ResBuf.h.

◆ newRb() [7/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdGePoint3d &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1529 of file ResBuf.h.

◆ newRb() [8/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdGeVector2d &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1553 of file ResBuf.h.

◆ newRb() [9/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdGeVector3d &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1577 of file ResBuf.h.

◆ newRb() [10/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdResBuf *  pNestedRb 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1747 of file ResBuf.h.

◆ newRb() [11/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
const OdString &  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1601 of file ResBuf.h.

◆ newRb() [12/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
double  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1481 of file ResBuf.h.

◆ newRb() [13/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdInt16  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1337 of file ResBuf.h.

◆ newRb() [14/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdInt32  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1385 of file ResBuf.h.

◆ newRb() [15/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdInt64  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1433 of file ResBuf.h.

◆ newRb() [16/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdInt8  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1289 of file ResBuf.h.

◆ newRb() [17/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdUInt16  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1361 of file ResBuf.h.

◆ newRb() [18/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdUInt32  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1409 of file ResBuf.h.

◆ newRb() [19/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdUInt64  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1457 of file ResBuf.h.

◆ newRb() [20/21]

static OdResBufPtr OdResBuf::newRb ( int  resType,
OdUInt8  resVal 
)
inlinestatic

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
resVal[in] Value of the corresponding type.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

Definition at line 1313 of file ResBuf.h.

◆ newRb() [21/21]

static OdResBufPtr OdResBuf::newRb ( int  resType = OdResBuf::kRtNone)
static

Create an instance of the ResBuf object of the specified data type and initialized the specified data value.

Parameters
resType[in] Group code as an Integer value.
Remarks
This method generate the OdError_InvalidResBuf exeption when the specified data value does not correspond to the specified data type.
See also
<link db_rb_sequence.html, Sequence of Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

◆ next()

OdResBufPtr OdResBuf::next ( ) const

Returns a smart pointer to the next ResBuf object in the sequence of tagged data.

See also
<link db_rb_sample_sequence.html, Example of Working with the Sequence of Tagged Data>
<link db_rb_sequence.html, Sequence of Tagged Data>

OdResBuf::last(), OdResBuf::setNext() methods

◆ ODRX_DECLARE_MEMBERS()

OdResBuf::ODRX_DECLARE_MEMBERS ( OdResBuf  )

◆ operator!=()

bool OdResBuf::operator!= ( const OdResBuf &  Rb) const
inline

Compares the specified ResBuf object with this ResBuf object whether object are not equal.

Parameters
Rb[in] Reference to the specified ResBuf object to be compared.
Returns
Returns true when group codes are different or data values are different, or false when group codes and data values are equal.
See also
<link db_rb.html, Working with Tagged Data>

Definition at line 1787 of file ResBuf.h.

◆ operator==()

bool OdResBuf::operator== ( const OdResBuf &  Rb) const

Compares the specified ResBuf object with this ResBuf object whether object are equal.

Parameters
Rb[in] Reference to the specified ResBuf object to be compared.
Remarks
Rreturns True when group codes and data values are equal, or False when group codes are different or data values are different.
See also
<link db_rb.html, Working with Tagged Data>

◆ restype()

int OdResBuf::restype ( ) const

Returns the group code as an Integer value which indicates the data type stored in the ResBuf object.

Remarks
Use the OdDxfCode::_getType() static method to determine the type of data associated with the returned group code.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_type.html, Getting and Setting Tagged Data>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::ValueType enumerator

OdResBuf::setRestype() method

◆ setAssertIndexByNewRb()

static void OdResBuf::setAssertIndexByNewRb ( int  index)
static

DOM

◆ setBinaryChunk()

void OdResBuf::setBinaryChunk ( const OdBinaryData &  bChunk)

Sets the data content of the ResBuf object using the specified binary chunk instance only if the stored group code has the BinaryChunk type.

Parameters
bChunk[in] Binary chunk instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the BinaryChunk type. The passed value must be the OdBinaryChunk instance.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getBinaryChunk(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

OdBinaryData, OdUInt8 classes

◆ setBool()

void OdResBuf::setBool ( bool  bValue)

Sets the data content of the ResBuf object using the specified Boolean value only if the stored group code has a Boolean type.

Parameters
bValue[in] Boolean value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Bool type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getBool(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setColor()

void OdResBuf::setColor ( const OdCmColor &  cmColor)

Sets the data content of the ResBuf object using the specified Color instance only if the group code is set to OdResBuf::kRtColor.

Parameters
cmColor[in] Color instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored group code is not set to kRtColor. The passed value must be the OdCmColor instance. The OdDxfCode::_getType() method returns Unknown type for it.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

<link cm.html, Colors and Transparencies>

OdResBuf::getColor(), OdResBuf::setRestype() methods

◆ setDouble()

void OdResBuf::setDouble ( double  realValue)

Sets the data content of the ResBuf object using the specified double-precision floating-point value only if the stored group code has a Double or Angle type.

Parameters
realValue[in] Double value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Double or Angle type. Use the ((double)value) instruction to convert the passed value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getDouble(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setHandle()

void OdResBuf::setHandle ( const OdDbHandle &  vHandle)

Sets the data content of the ResBuf object using the specified Handle instance only if the stored group code has the Handle type.

Parameters
vHandle[in] Handle instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Handle type. The passed value must be an instance of the OdDbHandle class or OdUInt64 class to be converted to Handle type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getHandle(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

OdDbHandle, OdUInt64 classes

◆ setInt16()

void OdResBuf::setInt16 ( OdInt16  iValue)

Sets the data content of the ResBuf object using the specified 16-bit Integer value only if the stored group code has an Integer type.

Parameters
iValue[in] 16-bit Integer value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer16 type. Use the ((OdInt16)value) instruction to convert
the passed value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getInt16(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setInt32()

void OdResBuf::setInt32 ( OdInt32  iValue)

Sets the data content of the ResBuf object using the specified 32-bit Integer value only if the stored group code has an Integer type.

Parameters
iValue[in] 32-bit Integer value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer32 type. Use the ((OdInt32)value) instruction to convert
the passed value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getInt32(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setInt64()

void OdResBuf::setInt64 ( OdInt64  iValue)

Sets the data content of the ResBuf object using the specified 64-bit Integer value only if the stored group code has an Integer type.

Parameters
iValue[in] 64-bit Integer value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer64 type. Use the ((OdInt64)value) instruction to convert
the passed value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getInt64(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setInt8()

void OdResBuf::setInt8 ( OdInt8  iValue)

Sets the data content of the ResBuf object using the specified 8-bit Integer value only if the stored group code has an Integer type.

Parameters
iValue[in] 8-bit Integer value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Integer8 type. Use the ((OdInt8)value) instruction to convert
the passed value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_typical.html, Getting and Setting Typical Data (integer, double, boolean)>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getInt8(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setNext()

OdResBufPtr OdResBuf::setNext ( OdResBuf *  pRb)

Sets the specified ResBuf object as the next ResBuf Object in the sequence of tagged data after the current ResBuf object that calls this method.

Parameters
pRb[in] Pointer to the existing ResBuf instance to be set.
Returns
Returns a smart pointer to the ResBuf object before which it was set.
See also
<link db_rb_sample_sequence.html, Example of Working with the Sequence of Tagged Data>
<link db_rb_sequence.html, Sequence of Tagged Data>

OdResBuf::next(), OdResBuf::last(), OdResBuf::insert() methods

◆ setObjectId()

void OdResBuf::setObjectId ( const OdDbObjectId &  idObject)

Sets the data content of the ResBuf object using the specified object ID instance only if the stored group code has the ObjectId, SoftPointerId, HardPointerId, SoftOwnershipId, or HardOwnershipId type.

Parameters
idObject[in] Object ID instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the ObjectId type. The passed value must be the OdDbObjectId instance. Only group codes kRtEntName and kDxfEnd store the object ID, other group codes store the handle.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_object.html, Getting and Setting Objects>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getEntName(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

OdDbObjectId, OdDbHandle classes

◆ setPickSet()

void OdResBuf::setPickSet ( const OdDbSelectionSet *  pSSet)

Sets the ResVal in this ResBuf object.

Parameters
pSSet[in] selection set.
Remarks
OdError_InvalidResBuf if ResType does not correspond to the type of ResVal.

◆ setPoint2d()

void OdResBuf::setPoint2d ( const OdGePoint2d &  gePoint)

Sets the data content of the ResBuf object using the specified two-dimesional point instance only if the stored group code has a Point type.

Parameters
gePoint[in] Two-dimesional point instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. The passed value must be the OdGePoint2d instance.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getPoint2d(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setPoint3d()

void OdResBuf::setPoint3d ( const OdGePoint3d &  gePoint)

Sets the data content of the ResBuf object using the specified three-dimesional point
instance only if the stored group code has a Point type.

Parameters
gePoint[in] Three-dimesional point instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. The passed value must be the OdGePoint3d instance.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getPoint3d(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setResBuf()

void OdResBuf::setResBuf ( const OdResBuf *  pResBuf)

Sets the data content of the ResBuf object using the specified ResBuf instance only if the group code is set to OdResBuf::kRtResBuf.

Parameters
pResBuf[in] Pointer to the existing ResBuf instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored group code is not set to kRtResBuf. The OdDxfCode::_getType() method returns Unknown type for it.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_other.html, Getting and Setting Specific Data (color, binary, resbuf)>

OdResBuf::getResBuf(), OdResBuf::setRestype() methods

◆ setRestype()

void OdResBuf::setRestype ( int  resType)

Sets the group code for the ResBuf object.

Parameters
resType[in] Group code as an Integer value.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_type.html, Getting and Setting Tagged Data>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::ValueType enumerator

OdResBuf::restype() method

◆ setString()

void OdResBuf::setString ( const OdString &  sValue)

Sets the data content of the ResBuf object using the specified String value only if the stored group code has a String type.

Parameters
sValue[in] String value to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the String type or Name type.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_string.html, Getting and Setting Strings>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getString(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setVector2d()

void OdResBuf::setVector2d ( const OdGeVector2d &  geVector)

Sets the data content of the ResBuf object using the specified two-dimesional vector
instance only if the stored group code has a Point type.

Parameters
geVector[in] Two-dimesional vector instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. The passed value must be the OdGeVector2d instance.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getVector2d(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

◆ setVector3d()

void OdResBuf::setVector3d ( const OdGeVector3d &  val)

Sets the data content of the ResBuf object using the specified three-dimesional vector
instance only if the stored group code has a Point type.

Parameters
geVector[in] Three-dimesional vector instance to be set.
Remarks
This method generates the OdError_InvalidResBuf exeption when the stored data type does not correspond to the Point type. The passed value must be the OdGeVector3d instance.
See also
<link db_rb_sample_codes.html, Example of Entering and Displaying Tagged Data>
<link db_rb_data_point.html, Getting and Setting Points and Vectors>

<link db_rb_verify.html, Determining the Data Type by Group Code>

OdResBuf::getVector3d(), OdResBuf::setRestype(), OdDxfCode::_getType() methods

Member Data Documentation

◆ m_data

Data OdResBuf::m_data
protected

Definition at line 1782 of file ResBuf.h.

◆ m_nCode

int OdResBuf::m_nCode
protected

Definition at line 1781 of file ResBuf.h.

◆ m_pNext

OdResBufPtr OdResBuf::m_pNext
protected

Definition at line 1783 of file ResBuf.h.

The documentation for this class was generated from the following file:
Generated on Mon Oct 12 2020 11:50:09