CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdFieldValue Class Reference

#include <DbFieldValue.h>

Inheritance diagram for OdFieldValue:
OdValue OdStaticRxObject< OdRxObject > OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdFieldValue)
 
 OdFieldValue ()
 
 OdFieldValue (const OdFieldValue &value)
 
 OdFieldValue (const OdString &value)
 
 OdFieldValue (OdInt32 value)
 
 OdFieldValue (double value)
 
 OdFieldValue (const OdInt64 &date)
 
 OdFieldValue (double x, double y)
 
 OdFieldValue (double x, double y, double z)
 
 OdFieldValue (const OdDbObjectId &objectId)
 
 OdFieldValue (const OdResBuf &resBuf)
 
 OdFieldValue (const void *buffer, OdInt32 bufferSize)
 
 OdFieldValue (const OdGePoint3d &p)
 
 OdFieldValue (const OdGeVector3d &p)
 
bool get (OdGePoint3d &p) const
 
bool get (OdGeVector3d &p) const
 
bool set (const OdGePoint3d &p)
 
bool set (const OdGeVector3d &p)
 
bool get (OdString &value) const
 
bool get (OdInt32 &value) const
 
bool get (double &value) const
 
bool get (OdInt64 &date) const
 
bool get (double &x, double &y) const
 
bool get (double &x, double &y, double &z) const
 
bool get (OdDbObjectId &objectId) const
 
bool get (OdResBufPtr &resBuf) const
 
bool get (void *&pBuf, OdInt32 &bufferSize) const
 
bool set (const OdValue &value)
 
bool set (const OdString &value)
 
bool set (OdInt32 value)
 
bool set (double value)
 
bool set (const OdInt64 &date)
 
bool set (double x, double y)
 
bool set (double x, double y, double z)
 
bool set (const OdDbObjectId &objectId)
 
bool set (const OdResBufPtr &resBuf)
 
bool set (const void *buffer, OdInt32 bufferSize)
 
- Public Member Functions inherited from OdValue
 ODRX_HEAP_OPERATORS ()
 
 ODRX_DECLARE_MEMBERS (OdValue)
 
 OdValue (void)
 
 ~OdValue (void)
 
 OdValue (const OdValue &value)
 
 OdValue (const OdString &value)
 
 OdValue (OdInt32 value)
 
 OdValue (double value)
 
 OdValue (const OdInt64 &date)
 
 OdValue (double x, double y)
 
 OdValue (double x, double y, double z)
 
 OdValue (const OdDbObjectId &objectId)
 
 OdValue (const OdResBufPtr &resBuf)
 
 OdValue (const void *buffer, OdInt32 bufferSize)
 
bool reset ()
 
OdValue::DataType dataType () const
 
bool isValid () const
 
 operator OdString () const
 
 operator OdInt32 () const
 
 operator double () const
 
 operator OdInt64 () const
 
 operator OdDbObjectId () const
 
OdValueoperator= (const OdValue &value)
 
OdValueoperator= (const OdString &value)
 
OdValueoperator= (OdInt32 value)
 
OdValueoperator= (double value)
 
OdValueoperator= (OdInt64 date)
 
OdValueoperator= (const OdDbObjectId &objectId)
 
OdValueoperator= (const OdResBufPtr &resBuf)
 
bool get (OdString &value) const
 
bool get (OdInt32 &value) const
 
bool get (double &value) const
 
bool get (OdInt64 &date) const
 
bool get (double &x, double &y) const
 
bool get (double &x, double &y, double &z) const
 
bool get (OdDbObjectId &objectId) const
 
bool get (OdResBufPtr &resBuf) const
 
bool get (void *&pBuf, OdInt32 &bufferSize) const
 
bool set (const OdValue &value)
 
bool set (const OdString &value)
 
bool set (OdInt32 value)
 
bool set (double value)
 
bool set (const OdInt64 &date)
 
bool set (double x, double y)
 
bool set (double x, double y, double z)
 
bool set (const OdDbObjectId &objectId)
 
bool set (const OdResBufPtr &resBuf)
 
bool set (const void *buffer, OdInt32 bufferSize)
 
bool reset (OdValue::DataType nDataType)
 
OdValue::UnitType unitType (void) const
 
void setUnitType (OdValue::UnitType nUnitType)
 
OdString getFormat (void) const
 
void setFormat (const OdString &pszFormat)
 
OdString format (OdDbDatabase *pDb=0) const
 
OdString format (OdValue::FormatOption nOption, OdDbDatabase *pDb=0)
 
OdString format (const OdString &pszFormat, OdValue::FormatOption nOption, OdDbDatabase *pDb=0)
 
bool format (const OdString &pszFormat, OdString &pszValue, OdDbDatabase *pDb=0) const
 
bool convertTo (OdValue::DataType nDataType, OdValue::UnitType nUnitType)
 
bool convertTo (OdValue::DataType nDataType, OdValue::UnitType nUnitType, bool bResetIfIncompatible)
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
- Public Member Functions inherited from OdStaticRxObject< OdRxObject >
void addRef ()
 
void release ()
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Public Types inherited from OdValue
enum  DataType {
  kUnknown = 0x00, kLong = 0x01, kDouble = 0x02, kString = 0x04,
  kDate = 0x08, kPoint = 0x10, k3dPoint = 0x20, kObjectId = 0x40,
  kBuffer = 0x80, kResbuf = 0x100, kGeneral = 0x200, kColor = 0x400
}
 
enum  UnitType {
  kUnitless = 0x00, kDistance = 0x01, kAngle = 0x02, kArea = 0x04,
  kVolume = 0x08, kCurrency = 0x10, kPercentage = 0x20
}
 
enum  ParseOption {
  kParseOptionNone = 0x00, kSetDefaultFormat = 0x01, kPreserveMtextFormat = 0x02, kConvertTextToValue = 0x04,
  kChangeDataType = 0x08, kParseTextForFieldCode = 0x10
}
 
enum  FormatOption {
  kFormatOptionNone = 0x00, kForEditing = 0x01, kForExpression = 0x02, kUseMaximumPrecision = 0x04,
  kIgnoreMtextFormat = 0x08
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdValue
 OdValue (OdValueImpl *pValImpl)
 
- Protected Attributes inherited from OdValue
OdValueImpl * m_pImpl
 

Detailed Description

This class represents Field Values for OdField objects in an OdDbDatabase instance.

Remarks
Field objects store both the Field expression and their evaluated values.

Fields can be evaluated by an evaluator to any one of the following data types: OdInt32,
Double, String, Date, Point, 3dPoint, ObjectId, Buffer, and Resbuf.

<group Other_Classes>

Definition at line 48 of file DbFieldValue.h.

Constructor & Destructor Documentation

◆ OdFieldValue() [1/13]

OdFieldValue::OdFieldValue ( )

◆ OdFieldValue() [2/13]

OdFieldValue::OdFieldValue ( const OdFieldValue value)
Parameters
value[in] Value.
date[in] Date value
x[in] X-coordinate of the point.
y[in] Y-coordinate of the point.
z[in] Z-coordinate of the point.
buffer[in] Buffer.
bufferSize[in] Buffer size.
resBuf[in] ResBuf list.
objectId[in] Object ID.

◆ OdFieldValue() [3/13]

OdFieldValue::OdFieldValue ( const OdString value)

◆ OdFieldValue() [4/13]

OdFieldValue::OdFieldValue ( OdInt32  value)

◆ OdFieldValue() [5/13]

OdFieldValue::OdFieldValue ( double  value)

◆ OdFieldValue() [6/13]

OdFieldValue::OdFieldValue ( const OdInt64 date)

◆ OdFieldValue() [7/13]

OdFieldValue::OdFieldValue ( double  x,
double  y 
)

◆ OdFieldValue() [8/13]

OdFieldValue::OdFieldValue ( double  x,
double  y,
double  z 
)

◆ OdFieldValue() [9/13]

OdFieldValue::OdFieldValue ( const OdDbObjectId objectId)

◆ OdFieldValue() [10/13]

OdFieldValue::OdFieldValue ( const OdResBuf resBuf)

◆ OdFieldValue() [11/13]

OdFieldValue::OdFieldValue ( const void buffer,
OdInt32  bufferSize 
)

◆ OdFieldValue() [12/13]

OdFieldValue::OdFieldValue ( const OdGePoint3d p)

◆ OdFieldValue() [13/13]

OdFieldValue::OdFieldValue ( const OdGeVector3d p)

Member Function Documentation

◆ get() [1/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
value[out] Receives the value.
Returns
Returns true if and only if successful.

◆ get() [2/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
x[out] Receives the X-coordinate of the point.
y[out] Receives the Y-coordinate of the point.
Returns
Returns true if and only if successful.

◆ get() [3/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
x[out] Receives the X-coordinate of the point.
y[out] Receives the Y-coordinate of the point.
z[out] Receives the Z-coordinate of the point.
Returns
Returns true if and only if successful.

◆ get() [4/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
objectId[in] Object ID.
\returns
Returns true if and only if successful.

◆ get() [5/11]

bool OdFieldValue::get ( OdGePoint3d p) const

◆ get() [6/11]

bool OdFieldValue::get ( OdGeVector3d p) const

◆ get() [7/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
value[out] Receives the value.
Returns
Returns true if and only if successful.

◆ get() [8/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
date[out] Receives the date value
Returns
Returns true if and only if successful.

◆ get() [9/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
resBuf[out] Receives the ResBuf list.
Returns
Returns true if and only if successful.

◆ get() [10/11]

bool OdValue::get

Returns the value of this FieldValue object.

Parameters
value[out] Receives the value.
Returns
Returns true if and only if successful.

◆ get() [11/11]

bool OdValue::get

Returns the value of this FieldValue object.

\param pBuf [out]  Receives a pointer to the buffer.
Parameters
bufferSize[out] Receives the buffer size.
\returns
Returns true if and only if successful.

◆ ODRX_DECLARE_MEMBERS()

OdFieldValue::ODRX_DECLARE_MEMBERS ( OdFieldValue  )

◆ set() [1/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
objectId[in] Object ID.
Returns
Returns true if and only if successful.

◆ set() [2/12]

bool OdFieldValue::set ( const OdGePoint3d p)

◆ set() [3/12]

bool OdFieldValue::set ( const OdGeVector3d p)

◆ set() [4/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
date[in] Date value
Returns
Returns true if and only if successful.

◆ set() [5/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
resBuf[in] ResBuf list.
Returns
Returns true if and only if successful.

◆ set() [6/12]

bool OdValue::set

Sets the value for this FieldValue object.

\param value [in]  Value.
Returns
Returns true if and only if successful.

◆ set() [7/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
value[in] Value.
\returns
Returns true if and only if successful.

◆ set() [8/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
buffer[in] Buffer.
bufferSize[in] Buffer size.
Returns
Returns true if and only if successful.

◆ set() [9/12]

bool OdValue::set

Sets the value for this FieldValue object.

\param value [in]  Value.

\returns

Returns true if and only if successful.

◆ set() [10/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
x[in] X-coordinate of the point.
y[in] Y-coordinate of the point.
Returns
Returns true if and only if successful.

◆ set() [11/12]

bool OdValue::set

Sets the value for this FieldValue object.

Parameters
x[in] X-coordinate of the point.
y[in] Y-coordinate of the point.
z[in] Z-coordinate of the point.
Returns
Returns true if and only if successful.

◆ set() [12/12]

bool OdValue::set

Sets the value for this FieldValue object.

\param value [in]  Value.

\returns

Returns true if and only if successful.


The documentation for this class was generated from the following file: