OdDbEntityHyperlinkPE Class Reference

#include <DbHyperlink.h>

Inheritance diagram for OdDbEntityHyperlinkPE:

Public Member Functions
	OdDbEntityHyperlinkPE ()
virtual	~OdDbEntityHyperlinkPE ()
	ODRX_DECLARE_MEMBERS (OdDbEntityHyperlinkPE)
virtual OdDbHyperlinkCollectionPtr	getHyperlinkCollection (const OdRxObject *pObject, bool oneOnly=false, bool ignoreBlockDefinition=true)=0
virtual OdDbHyperlinkCollectionPtr	getHyperlinkCollectionEx (const OdRxObject *pObject, bool oneOnly=false, bool ignoreBlockDefinition=true)
virtual OdDbHyperlinkCollectionPtr	getHyperlinkCollection (const OdDbStubPtrArray *&objectIds, bool oneOnly=false, bool ignoreBlockDefinition=true)=0
virtual void	setHyperlinkCollection (const OdRxObject *pObject, OdDbHyperlinkCollection *pHCO)=0
virtual unsigned int	getHyperlinkCount (const OdRxObject *pObject, bool ignoreBlockDefinition=true)=0
virtual unsigned int	getHyperlinkCount (const OdDbStubPtrArray *&idContainers, bool ignoreBlockDefinition=true)=0
virtual bool	hasHyperlink (const OdRxObject *pObject, bool ignoreBlockDefinition=true)=0
virtual bool	hasHyperlink (const OdDbStubPtrArray *&objectIds, bool ignoreBlockDefinition=true)=0
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 void	copyFrom (const OdRxObject *pSource)
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 ()

Detailed Description

This class is the Hyperlink Protocol Extension class.

Remarks

This class provides access to the Hyperlink objects associated with OdDbDatabase objects.

See also

OdDbEntityHyperlinkPE OdDbHyperlink OdDbHyperlinkCollection

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 296 of file DbHyperlink.h.

Constructor & Destructor Documentation

OdDbEntityHyperlinkPE()

OdDbEntityHyperlinkPE::OdDbEntityHyperlinkPE

(

)

Default constructor. Creates a new object of the OdDbEntityHyperlinkPE class.

~OdDbEntityHyperlinkPE()

virtual OdDbEntityHyperlinkPE::~OdDbEntityHyperlinkPE ( )

virtual

Virtual destructor. Destroys an object of the OdDbEntityHyperlinkPE class and releases all resources that were used by the object.

Member Function Documentation

getHyperlinkCollection() [1/2]

virtual OdDbHyperlinkCollectionPtr OdDbEntityHyperlinkPE::getHyperlinkCollection ( const OdDbStubPtrArray *&  objectIds, bool  oneOnly = false, bool  ignoreBlockDefinition = true  )

pure virtual

Creates a HyperlinkCollection object containing Hyperlink objects associated with the specified objects.

Parameters

objectIds	[in] Array of Object IDs.
oneOnly	[in] If true, returns only the first Hyperlink.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

Smart pointer to the created HyperlinkColection object.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

getHyperlinkCollection() [2/2]

virtual OdDbHyperlinkCollectionPtr OdDbEntityHyperlinkPE::getHyperlinkCollection ( const OdRxObject *  pObject, bool  oneOnly = false, bool  ignoreBlockDefinition = true  )

pure virtual

Creates a HyperlinkCollection object containing the Hyperlink object associated with the specified object.

Parameters

pObject	[in] Pointer to the object.
oneOnly	[in] If true, returns only the first Hyperlink.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

Smart pointer to the created HyperlinkColection object.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

getHyperlinkCollectionEx()

virtual OdDbHyperlinkCollectionPtr OdDbEntityHyperlinkPE::getHyperlinkCollectionEx ( const OdRxObject *  pObject, bool  oneOnly = false, bool  ignoreBlockDefinition = true  )

inlinevirtual

Creates a HyperlinkCollection object containing the Hyperlink object associated with the specified object.

Parameters

pObject	[in] Pointer to the object.
oneOnly	[in] If true, returns only the first Hyperlink.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

Smart pointer to the created HyperlinkColection object.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

Definition at line 353 of file DbHyperlink.h.

getHyperlinkCount() [1/2]

virtual unsigned int OdDbEntityHyperlinkPE::getHyperlinkCount ( const OdDbStubPtrArray *&  idContainers, bool  ignoreBlockDefinition = true  )

pure virtual

Returns the number of Hyperlink objects associated with the specified objects.

Parameters

idContainers	[in] Array of object IDs.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

Number of Hyperlink objects.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

getHyperlinkCount() [2/2]

virtual unsigned int OdDbEntityHyperlinkPE::getHyperlinkCount ( const OdRxObject *  pObject, bool  ignoreBlockDefinition = true  )

pure virtual

Returns the number of Hyperlink objects associated with the specified object.

Parameters

pObject	[in] Pointer to the object.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

Number of Hyperlink objects.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

hasHyperlink() [1/2]

virtual bool OdDbEntityHyperlinkPE::hasHyperlink ( const OdDbStubPtrArray *&  objectIds, bool  ignoreBlockDefinition = true  )

pure virtual

Returns true if and only if at least one of the specified objects has Hyperlink objects associated with it.

Parameters

objectIds	[in] Array of object IDs.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

True if one or more of the specified objects have Hyperlink objects associated with them; false if none of the specified objects have Hyperlink objects associated with them.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

hasHyperlink() [2/2]

virtual bool OdDbEntityHyperlinkPE::hasHyperlink ( const OdRxObject *  pObject, bool  ignoreBlockDefinition = true  )

pure virtual

Returns true if and only if the specified object has Hyperlink objects associated with it.

Parameters

pObject	[in] Pointer to the object.
ignoreBlockDefinition	[in] If true, ignores Hyperlink objects associated with block definitions.

Returns

True if the specified object has Hyperlink objects associated with it; false otherwise.

Remarks

Currently the ignoreBlockDefinition argument is ignored. It will be fully implemented in future releases.

ODRX_DECLARE_MEMBERS()

OdDbEntityHyperlinkPE::ODRX_DECLARE_MEMBERS

(

OdDbEntityHyperlinkPE

)

setHyperlinkCollection()

virtual void OdDbEntityHyperlinkPE::setHyperlinkCollection ( const OdRxObject *  pObject, OdDbHyperlinkCollection *  pHCO  )

pure virtual

Associates the specified HyperlinkCollection object with the specified object.

Parameters

pObject	[in] Pointer to the target object.
pHCO	[in] Pointer to the HyperlinkCollection object.

Remarks

Hyperlink objects with NULL name, description or sublocation will not be added to the target object.

---

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

• DbHyperlink.h