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

#include <DbIdMapping.h>

Public Member Functions

 OdDbIdPair ()
 
 OdDbIdPair (const OdDbIdPair &source)
 
 OdDbIdPair (const OdDbObjectId &key)
 
 OdDbIdPair (const OdDbObjectId &key, const OdDbObjectId &value, bool cloned=false, bool ownerXlated=true, bool primary=false)
 
OdDbObjectId key () const
 
OdDbObjectId value () const
 
bool isCloned () const
 
bool isPrimary () const
 
bool isOwnerXlated () const
 
OdDbIdPairset (const OdDbObjectId &key, const OdDbObjectId &value, bool cloned=false, bool ownerXlated=true, bool primary=false)
 
void setKey (const OdDbObjectId &key)
 
void setValue (const OdDbObjectId &value)
 
void setCloned (bool cloned)
 
void setPrimary (bool primary)
 
void setOwnerXlated (bool ownerXlated)
 

Detailed Description

This class is the element class for OdDbMapping, which is used in deepclone operations to map Object IDs from the original objects to their clones.

See also
TD_Db
Remarks
Key is the Object ID of the original object.
Value is the Object ID of the cloned object.

<group OdDb_Classes>

Definition at line 59 of file DbIdMapping.h.

Constructor & Destructor Documentation

◆ OdDbIdPair() [1/4]

OdDbIdPair::OdDbIdPair ( )
inline
Parameters
source[in] OdDbIdPair to be copied.
key[in] Object ID to use as key.
value[in] Object ID to use as Value.
cloned[in] Key object has been cloned.
ownerXlated[in] Owner of key object has been translated.
primary[in] Key object is primary.

Definition at line 69 of file DbIdMapping.h.

◆ OdDbIdPair() [2/4]

OdDbIdPair::OdDbIdPair ( const OdDbIdPair source)
inline

Definition at line 72 of file DbIdMapping.h.

◆ OdDbIdPair() [3/4]

OdDbIdPair::OdDbIdPair ( const OdDbObjectId key)
inline

Definition at line 80 of file DbIdMapping.h.

◆ OdDbIdPair() [4/4]

OdDbIdPair::OdDbIdPair ( const OdDbObjectId key,
const OdDbObjectId value,
bool  cloned = false,
bool  ownerXlated = true,
bool  primary = false 
)
inline

Definition at line 87 of file DbIdMapping.h.

Member Function Documentation

◆ isCloned()

bool OdDbIdPair::isCloned ( ) const
inline

Returns true if and only if the key object for this IdPair object has been cloned.

Definition at line 113 of file DbIdMapping.h.

◆ isOwnerXlated()

bool OdDbIdPair::isOwnerXlated ( ) const
inline

Returns true if and only if the owner of the key object for this IdPair object has been translated.

Definition at line 123 of file DbIdMapping.h.

◆ isPrimary()

bool OdDbIdPair::isPrimary ( ) const
inline

Returns true if the key object for this IdPair is primary.

Definition at line 118 of file DbIdMapping.h.

◆ key()

OdDbObjectId OdDbIdPair::key ( ) const
inline

Returns the key for this IdPair object.

Definition at line 103 of file DbIdMapping.h.

◆ set()

OdDbIdPair& OdDbIdPair::set ( const OdDbObjectId key,
const OdDbObjectId value,
bool  cloned = false,
bool  ownerXlated = true,
bool  primary = false 
)
inline

Sets the parameters for this IdPair object according to the arguments.

Parameters
key[in] Object ID to use as key.
value[in] Object ID to use as Value.
cloned[in] Key object has been cloned.
ownerXlated[in] Owner of key object has been translated.

Definition at line 133 of file DbIdMapping.h.

◆ setCloned()

void OdDbIdPair::setCloned ( bool  cloned)
inline

Controls the cloned setting for this IdPair object.

Parameters
cloned[in] Key object has been cloned.

Definition at line 169 of file DbIdMapping.h.

◆ setKey()

void OdDbIdPair::setKey ( const OdDbObjectId key)
inline

Sets the key for this IdPair object.

Parameters
key[in] Object ID to use as key.

Definition at line 153 of file DbIdMapping.h.

◆ setOwnerXlated()

void OdDbIdPair::setOwnerXlated ( bool  ownerXlated)
inline

Controls the owner translated setting for this IdPair object.

Parameters
ownerXlated[in] Owner of key object has been translated.

Definition at line 184 of file DbIdMapping.h.

◆ setPrimary()

void OdDbIdPair::setPrimary ( bool  primary)
inline

Controls the primary setting for this IdPair object.

Parameters
cloned[in] Key object is primary.

Definition at line 177 of file DbIdMapping.h.

◆ setValue()

void OdDbIdPair::setValue ( const OdDbObjectId value)
inline

Sets the value for this IdPair object.

Parameters
value[in] Object ID to use as Value.

Definition at line 161 of file DbIdMapping.h.

◆ value()

OdDbObjectId OdDbIdPair::value ( ) const
inline

Returns the value for this IdPair object.

Definition at line 108 of file DbIdMapping.h.


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