OdSpatialReference::OdDefinitionBase Class Reference

#include <OdDefinitionBase.h>

Inheritance diagram for OdSpatialReference::OdDefinitionBase:

Public Member Functions
void	initialize (bool bReset=false)
OdResult	update ()
OdResult	remove ()
DefinitionType	getDefinitionType () const
OdResult	getCode (OdString &sCode) const
OdResult	setCode (const OdString &sCode)
OdResult	getDescription (OdString &sDescription) const
OdResult	setDescription (const OdString &sDescription)
OdResult	getSource (OdString &sSource) const
OdResult	setSource (const OdString &sSource)
virtual void	copyFrom (const OdRxObject *pSource) ODRX_OVERRIDE
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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Detailed Description

This class is the base class for definition classes.

<group OdSpatialReference_Classes>

Definition at line 62 of file OdDefinitionBase.h.

Member Function Documentation

copyFrom()

virtual void OdSpatialReference::OdDefinitionBase::copyFrom ( const OdRxObject * pSource )

virtual

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

Parameters

pSource

[in] Pointer to the source object.

Remarks

The default implementation of this function does nothing but throw an eNotApplicable exception.

Throws: eNotApplicable Exception

Reimplemented from OdRxObject.

getCode()

OdResult OdSpatialReference::OdDefinitionBase::getCode

(

OdString &

sCode

)

const

Returns the code of base definition.

Parameters

sCode

[out] Code of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

getDefinitionType()

DefinitionType OdSpatialReference::OdDefinitionBase::getDefinitionType

(

)

const

Returns the type of base definition.

Returns

Returns the DefinitionType of base definition.

getDescription()

OdResult OdSpatialReference::OdDefinitionBase::getDescription

(

OdString &

sDescription

)

const

Returns the description of base definition.

Parameters

sDescription

[out] Description of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

getSource()

OdResult OdSpatialReference::OdDefinitionBase::getSource

(

OdString &

sSource

)

const

Returns the source of base definition.

Parameters

sSource

[out] Source of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

initialize()

void OdSpatialReference::OdDefinitionBase::initialize

(

bool

bReset = false

)

Initializes or resets definition data to initial values.

Parameters

bReset

[in] If true - the definition data will be reset to initial values regardless of whether this definition data is initialized or not.

remove()

OdResult OdSpatialReference::OdDefinitionBase::remove

(

)

Removes data of this definition from its dictionary.

Returns

Returns eOK if successful, or an appropriate error code if not.

setCode()

OdResult OdSpatialReference::OdDefinitionBase::setCode

(

const OdString &

sCode

)

Sets the code of base definition.

Parameters

sCode

[in] Code of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

setDescription()

OdResult OdSpatialReference::OdDefinitionBase::setDescription

(

const OdString &

sDescription

)

Sets the description of base definition.

Parameters

sDescription

[in] Description of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

setSource()

OdResult OdSpatialReference::OdDefinitionBase::setSource

(

const OdString &

sSource

)

Sets the source of base definition.

Parameters

sSource

[in] Source of base definition.

Returns

Returns eOK if successful, or an appropriate error code if not.

update()

OdResult OdSpatialReference::OdDefinitionBase::update

(

)

Adds or updates data of this definition in its dictionary.

Returns

Returns eOK if successful, or an appropriate error code if not.

---

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

• OdDefinitionBase.h