CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Static Protected Member Functions | List of all members
AECVariant Class Reference

#include <AECVariant.h>

Inheritance diagram for AECVariant:
OdVariant

Public Types

enum  Type {
  eUndefined = -2 , eEmpty = -1 , eInt32 = 3 , eReal = 5 ,
  eString = 8 , eBool = 11 , eUInt32 = 19 , eVariantArray = 8204
}
 

Public Member Functions

 AECVariant ()
 
 AECVariant (const AECVariant &vValue)
 
 AECVariant (OdInt32 iValue)
 
 AECVariant (const OdString &strValue, bool bProcessEscapeSequences=false)
 
 AECVariant (bool bValue)
 
 AECVariant (double dValue)
 
 ~AECVariant ()
 
bool operator== (const AECVariant &vtValue) const
 
bool operator!= (const AECVariant &vtValue) const
 
bool operator> (const AECVariant &vtValue) const
 
bool operator< (const AECVariant &vtValue) const
 
AECVariant & operator= (const AECVariant &vtValue)
 
AECVariant operator+ (const AECVariant &vtValue)
 
AECVariant & operator+= (const AECVariant &vtValue)
 
AECVariant operator- (const AECVariant &vtValue)
 
AECVariant operator* (const AECVariant &vtValue)
 
AECVariant operator/ (const AECVariant &vtValue)
 
AECVariant operator& (const AECVariant &vtValue)
 
AECVariant operator&& (const AECVariant &vtValue)
 
AECVariant operator|| (const AECVariant &vtValue)
 
AECVariant operator! ()
 
Type GetType () const
 
OdInt32 GetInt32 () const
 
const OdString & GetString () const
 
bool GetBool () const
 
double GetDouble () const
 
const AECVariantArray & GetArray () const
 
void SetInt32 (OdInt32 uValue)
 
void SetString (const OdString &strValue)
 
void SetBool (bool bValue)
 
void SetDouble (double dValue)
 
void SetArray (const AECVariantArray &arr)
 
void SetEmpty ()
 
void SetUndefined ()
 

Protected Types

enum  RxVariantType { kRxVariant = OdVariant::kNextType , kNextType }
 
- Protected Types inherited from OdVariant
enum  Type {
  kVoid = 0x0000 , kString = 0x0001 , kBool = 0x0002 , kInt8 = 0x0003 ,
  kUInt8 = 0x0003 , kInt16 = 0x0004 , kUInt16 = 0x0004 , kInt32 = 0x0005 ,
  kUInt32 = 0x0005 , kInt64 = 0x0006 , kUInt64 = 0x0006 , kDouble = 0x0007 ,
  kWString = 0x0008 , kAnsiString = 0x0008 , kRxObjectPtr = 0x0009 , kNextType = 0x000A ,
  kByRef = 0x0040 , kArray = 0x0080
}
 

Protected Member Functions

void setVarType (int newType, int &type, void *data)
 
- Protected Member Functions inherited from OdVariant
void * data () const
 
virtual void setVarType (int newType, int &type, void *data)
 
 OdVariant ()
 
 OdVariant (const OdVariant &val)
 
OdVariant & operator= (const OdVariant &val)
 
virtual ~OdVariant ()
 
int varType () const
 
Type type () const
 
bool isArray () const
 
bool isByRef () const
 
 OdVariant (const OdString &val)
 
 OdVariant (const OdAnsiString &val)
 
 OdVariant (const OdRxObjectPtr &val)
 
 OdVariant (bool val)
 
 OdVariant (OdInt8 val)
 
 OdVariant (OdUInt8 val)
 
 OdVariant (OdInt16 val)
 
 OdVariant (OdUInt16 val)
 
 OdVariant (OdInt32 val)
 
 OdVariant (OdUInt32 val)
 
 OdVariant (OdInt64 val)
 
 OdVariant (OdUInt64 val)
 
 OdVariant (double val)
 
const OdString & getString () const
 
const OdAnsiString & getAnsiString () const
 
const OdRxObjectPtr & getRxObjectPtr () const
 
bool getBool () const
 
OdInt8 getInt8 () const
 
OdUInt8 getUInt8 () const
 
OdInt16 getInt16 () const
 
OdUInt16 getUInt16 () const
 
OdInt32 getInt32 () const
 
OdUInt32 getUInt32 () const
 
OdInt64 getInt64 () const
 
OdUInt64 getUInt64 () const
 
OdIntPtr getIntPtr () const
 
double getDouble () const
 
OdString * getStringPtr () const
 
OdAnsiString * getAnsiStringPtr () const
 
OdRxObjectPtr * getRxObjectPtrPtr () const
 
bool * getBoolPtr () const
 
OdInt8 * getInt8Ptr () const
 
OdUInt8 * getUInt8Ptr () const
 
OdInt16 * getInt16Ptr () const
 
OdUInt16 * getUInt16Ptr () const
 
OdInt32 * getInt32Ptr () const
 
OdUInt32 * getUInt32Ptr () const
 
OdInt64 * getInt64Ptr () const
 
OdUInt64 * getUInt64Ptr () const
 
double * getDoublePtr () const
 
const OdStringArray & getStringArray () const
 
const OdAnsiStringArray & getAnsiStringArray () const
 
const OdRxObjectPtrArray & getRxObjectPtrArray () const
 
const OdBoolArray & getBoolArray () const
 
const OdInt8Array & getInt8Array () const
 
const OdUInt8Array & getUInt8Array () const
 
const OdInt16Array & getInt16Array () const
 
const OdUInt16Array & getUInt16Array () const
 
const OdInt32Array & getInt32Array () const
 
const OdUInt32Array & getUInt32Array () const
 
const OdInt64Array & getInt64Array () const
 
const OdUInt64Array & getUInt64Array () const
 
const OdDoubleArray & getDoubleArray () const
 
OdStringArray & asStringArray ()
 
OdAnsiStringArray & asAnsiStringArray ()
 
OdRxObjectPtrArray & asRxObjectPtrArray ()
 
OdBoolArray & asBoolArray ()
 
OdInt8Array & asInt8Array ()
 
OdUInt8Array & asUInt8Array ()
 
OdInt16Array & asInt16Array ()
 
OdUInt16Array & asUInt16Array ()
 
OdInt32Array & asInt32Array ()
 
OdUInt32Array & asUInt32Array ()
 
OdInt64Array & asInt64Array ()
 
OdUInt64Array & asUInt64Array ()
 
OdDoubleArray & asDoubleArray ()
 
OdStringArray * getStringArrayPtr () const
 
OdAnsiStringArray * getAnsiStringArrayPtr () const
 
OdRxObjectPtrArray * getRxObjectPtrArrayPtr () const
 
OdBoolArray * getBoolArrayPtr () const
 
OdInt8Array * getInt8ArrayPtr () const
 
OdUInt8Array * getUInt8ArrayPtr () const
 
OdInt16Array * getInt16ArrayPtr () const
 
OdUInt16Array * getUInt16ArrayPtr () const
 
OdInt32Array * getInt32ArrayPtr () const
 
OdUInt32Array * getUInt32ArrayPtr () const
 
OdInt64Array * getInt64ArrayPtr () const
 
OdUInt64Array * getUInt64ArrayPtr () const
 
OdDoubleArray * getDoubleArrayPtr () const
 
OdVariant & setString (const OdString &val)
 
OdVariant & setAnsiString (const OdAnsiString &val)
 
OdVariant & setRxObjectPtr (const OdRxObjectPtr &val)
 
OdVariant & setBool (bool val)
 
OdVariant & setInt8 (OdInt8 val)
 
OdVariant & setUInt8 (OdUInt8 val)
 
OdVariant & setInt16 (OdInt16 val)
 
OdVariant & setUInt16 (OdUInt16 val)
 
OdVariant & setInt32 (OdInt32 val)
 
OdVariant & setUInt32 (OdUInt32 val)
 
OdVariant & setInt64 (OdInt64 val)
 
OdVariant & setUInt64 (OdUInt64 val)
 
OdVariant & setIntPtr (OdIntPtr val)
 
OdVariant & setDouble (double val)
 
OdVariant & setStringPtr (OdString *val)
 
OdVariant & setAnsiStringPtr (OdAnsiString *val)
 
OdVariant & setRxObjectPtrPtr (OdRxObjectPtr *val)
 
OdVariant & setBoolPtr (bool *val)
 
OdVariant & setInt8Ptr (OdInt8 *val)
 
OdVariant & setUInt8Ptr (OdUInt8 *val)
 
OdVariant & setInt16Ptr (OdInt16 *val)
 
OdVariant & setUInt16Ptr (OdUInt16 *val)
 
OdVariant & setInt32Ptr (OdInt32 *val)
 
OdVariant & setUInt32Ptr (OdUInt32 *val)
 
OdVariant & setInt64Ptr (OdInt64 *val)
 
OdVariant & setUInt64Ptr (OdUInt64 *val)
 
OdVariant & setDoublePtr (double *val)
 
OdVariant & setStringArray (const OdStringArray &val)
 
OdVariant & setAnsiStringArray (const OdAnsiStringArray &val)
 
OdVariant & setRxObjectPtrArray (const OdRxObjectPtrArray &val)
 
OdVariant & setBoolArray (const OdBoolArray &val)
 
OdVariant & setInt8Array (const OdInt8Array &val)
 
OdVariant & setUInt8Array (const OdUInt8Array &val)
 
OdVariant & setInt16Array (const OdInt16Array &val)
 
OdVariant & setUInt16Array (const OdUInt16Array &val)
 
OdVariant & setInt32Array (const OdInt32Array &val)
 
OdVariant & setUInt32Array (const OdUInt32Array &val)
 
OdVariant & setInt64Array (const OdInt64Array &val)
 
OdVariant & setUInt64Array (const OdUInt64Array &val)
 
OdVariant & setDoubleArray (const OdDoubleArray &val)
 
OdVariant & setStringArrayPtr (OdStringArray *val)
 
OdVariant & setAnsiStringArrayPtr (OdAnsiStringArray *val)
 
OdVariant & setRxObjectPtrArrayPtr (OdRxObjectPtrArray *val)
 
OdVariant & setBoolArrayPtr (OdBoolArray *val)
 
OdVariant & setInt8ArrayPtr (OdInt8Array *val)
 
OdVariant & setUInt8ArrayPtr (OdUInt8Array *val)
 
OdVariant & setInt16ArrayPtr (OdInt16Array *val)
 
OdVariant & setUInt16ArrayPtr (OdUInt16Array *val)
 
OdVariant & setInt32ArrayPtr (OdInt32Array *val)
 
OdVariant & setUInt32ArrayPtr (OdUInt32Array *val)
 
OdVariant & setInt64ArrayPtr (OdInt64Array *val)
 
OdVariant & setUInt64ArrayPtr (OdUInt64Array *val)
 
OdVariant & setDoubleArrayPtr (OdDoubleArray *val)
 

Static Protected Member Functions

static const OdVariant::TypeFactory * typeFactory (int type)
 
- Static Protected Member Functions inherited from OdVariant
static const TypeFactory * typeFactory (int type)
 

Additional Inherited Members

- Protected Attributes inherited from OdVariant
int m_type
 
union {
   OdUInt8   uint8 [nOdVariantDataSize]
 
   double   dbl
 
   void *   ptr
 
} m_uData
 

Detailed Description

AEC variant

Remarks
Used mainly for scheduling purposes. See AECDbScheduleTable.

<group TA_API_Auxiliary_Classes>

Definition at line 43 of file AECVariant.h.

Member Enumeration Documentation

◆ RxVariantType

enum AECVariant::RxVariantType
protected
Enumerator
kRxVariant 
kNextType 

Definition at line 243 of file AECVariant.h.

◆ Type

enum AECVariant::Type

Type of variant.

Enumerator
eUndefined 
eEmpty 
eInt32 
eReal 
eString 
eBool 
eUInt32 
eVariantArray 

Definition at line 165 of file AECVariant.h.

Constructor & Destructor Documentation

◆ AECVariant() [1/6]

AECVariant::AECVariant ( )

Default constructor.

◆ AECVariant() [2/6]

AECVariant::AECVariant ( const AECVariant &  vValue)

Copy constructor.

◆ AECVariant() [3/6]

AECVariant::AECVariant ( OdInt32  iValue)

Constructor. Sets variant to integer.

Parameters
iValue[in] Integer.

◆ AECVariant() [4/6]

AECVariant::AECVariant ( const OdString &  strValue,
bool  bProcessEscapeSequences = false 
)

Constructor. Sets variant to string.

Parameters
strValue[in] String.
bProcessEscapeSequences[in] Whether to process escape sequences.

◆ AECVariant() [5/6]

AECVariant::AECVariant ( bool  bValue)

Constructor. Sets variant to bool.

Parameters
bValue[in] Boolean.

◆ AECVariant() [6/6]

AECVariant::AECVariant ( double  dValue)

Constructor. Sets variant to double.

Parameters
dValue[in] Double.

◆ ~AECVariant()

AECVariant::~AECVariant ( )

Destructor.

Member Function Documentation

◆ GetArray()

const AECVariantArray & AECVariant::GetArray ( ) const

Returns double AECVariantArray.

◆ GetBool()

bool AECVariant::GetBool ( ) const

Returns boolean value.

◆ GetDouble()

double AECVariant::GetDouble ( ) const

Returns double value.

◆ GetInt32()

OdInt32 AECVariant::GetInt32 ( ) const

Returns UInt32 value.

◆ GetString()

const OdString & AECVariant::GetString ( ) const

Returns string value.

◆ GetType()

Type AECVariant::GetType ( ) const

Returns the type of variant.

◆ operator!()

AECVariant AECVariant::operator! ( )

! operator.

◆ operator!=()

bool AECVariant::operator!= ( const AECVariant &  vtValue) const

!= operator.

◆ operator&()

AECVariant AECVariant::operator& ( const AECVariant &  vtValue)

& operator.

◆ operator&&()

AECVariant AECVariant::operator&& ( const AECVariant &  vtValue)

&& operator.

◆ operator*()

AECVariant AECVariant::operator* ( const AECVariant &  vtValue)

operator.

◆ operator+()

AECVariant AECVariant::operator+ ( const AECVariant &  vtValue)
  • operator.

◆ operator+=()

AECVariant & AECVariant::operator+= ( const AECVariant &  vtValue)

+= operator.

◆ operator-()

AECVariant AECVariant::operator- ( const AECVariant &  vtValue)
  • operator.

◆ operator/()

AECVariant AECVariant::operator/ ( const AECVariant &  vtValue)

/ operator.

◆ operator<()

bool AECVariant::operator< ( const AECVariant &  vtValue) const

< operator.

◆ operator=()

AECVariant & AECVariant::operator= ( const AECVariant &  vtValue)

= operator.

◆ operator==()

bool AECVariant::operator== ( const AECVariant &  vtValue) const

== operator.

◆ operator>()

bool AECVariant::operator> ( const AECVariant &  vtValue) const

‍operator.

◆ operator||()

AECVariant AECVariant::operator|| ( const AECVariant &  vtValue)

|| operator.

◆ SetArray()

void AECVariant::SetArray ( const AECVariantArray &  arr)

Sets variant to array value.

◆ SetBool()

void AECVariant::SetBool ( bool  bValue)

Sets variant to boolean value.

◆ SetDouble()

void AECVariant::SetDouble ( double  dValue)

Sets variant to double value.

◆ SetEmpty()

void AECVariant::SetEmpty ( )

Forces variant to be of empty type.

◆ SetInt32()

void AECVariant::SetInt32 ( OdInt32  uValue)

Sets variant to integer value.

◆ SetString()

void AECVariant::SetString ( const OdString &  strValue)

Sets variant to string value.

◆ SetUndefined()

void AECVariant::SetUndefined ( )

Forces variant to be of undefined type.

◆ setVarType()

void AECVariant::setVarType ( int  newType,
int &  type,
void *  data 
)
protectedvirtual

Reimplemented from OdVariant.

◆ typeFactory()

static const OdVariant::TypeFactory * AECVariant::typeFactory ( int  type)
staticprotected
The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:30:41