diff options
Diffstat (limited to 'docs/API/classAdobeXMPCommon_1_1ISharedObject.html')
| -rwxr-xr-x | docs/API/classAdobeXMPCommon_1_1ISharedObject.html | 205 |
1 files changed, 205 insertions, 0 deletions
diff --git a/docs/API/classAdobeXMPCommon_1_1ISharedObject.html b/docs/API/classAdobeXMPCommon_1_1ISharedObject.html new file mode 100755 index 0000000..43ee17f --- /dev/null +++ b/docs/API/classAdobeXMPCommon_1_1ISharedObject.html @@ -0,0 +1,205 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>AdobeXMPCommon::ISharedObject Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<img src="xmp_tagline_small.jpg" width="125" height="50" border="0"><p> +<!-- Generated by Doxygen 1.8.11 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('classAdobeXMPCommon_1_1ISharedObject.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classAdobeXMPCommon_1_1ISharedObject-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">AdobeXMPCommon::ISharedObject Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Interface that serves as the base interface of all the externally exposed interfaces. + <a href="classAdobeXMPCommon_1_1ISharedObject.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="ISharedObject_8h_source.html">ISharedObject.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for AdobeXMPCommon::ISharedObject:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classAdobeXMPCommon_1_1ISharedObject.png" usemap="#AdobeXMPCommon::ISharedObject_map" alt=""/> + <map id="AdobeXMPCommon::ISharedObject_map" name="AdobeXMPCommon::ISharedObject_map"> +<area href="classAdobeXMPCommon_1_1IConfigurationManager__v1.html" title="Version1 of the interface that represents configuration settings controllable by the client..." alt="AdobeXMPCommon::IConfigurationManager_v1" shape="rect" coords="303,56,596,80"/> +<area href="classAdobeXMPCommon_1_1IError__v1.html" title="Version1 of the interface that represents an error/warning encountered during processing. " alt="AdobeXMPCommon::IError_v1" shape="rect" coords="303,112,596,136"/> +<area href="classAdobeXMPCommon_1_1IUTF8String__v1.html" title="Version1 of the interface that represents an UTF8String. " alt="AdobeXMPCommon::IUTF8String_v1" shape="rect" coords="303,168,596,192"/> +<area href="classAdobeXMPCore_1_1IDOMImplementationRegistry__v1.html" title="Version1 of the interface that serves as a database/registry of all the parsers and serializers avail..." alt="AdobeXMPCore::IDOMImplementationRegistry_v1" shape="rect" coords="303,224,596,248"/> +<area href="classAdobeXMPCore_1_1IDOMParser__v1.html" title="Version 1 of the interface that supports parsing of the XMP Data Model. " alt="AdobeXMPCore::IDOMParser_v1" shape="rect" coords="303,280,596,304"/> +<area href="classAdobeXMPCore_1_1IDOMSerializer__v1.html" title="Version1 of the interface that represents an object that can serialize an XMP Data Model to a buffer..." alt="AdobeXMPCore::IDOMSerializer_v1" shape="rect" coords="303,336,596,360"/> +<area href="classAdobeXMPCore_1_1INameSpacePrefixMap__v1.html" title="Version1 of the interface that represents map where each entry consists of prefix string as the key a..." alt="AdobeXMPCore::INameSpacePrefixMap_v1" shape="rect" coords="303,392,596,416"/> +<area href="classAdobeXMPCore_1_1INode__v1.html" title="Version1 of the interface that serves as a base interface to all types of nodes in the XMP DOM..." alt="AdobeXMPCore::INode_v1" shape="rect" coords="303,448,596,472"/> +<area href="classAdobeXMPCore_1_1INodeIterator__v1.html" title="Interface that represents an iterator over the mutable children of a XMP DOM Node. " alt="AdobeXMPCore::INodeIterator_v1" shape="rect" coords="303,504,596,528"/> +<area href="classAdobeXMPCore_1_1IPath__v1.html" title="Version1 of the interface that provides an easy iterative description of a specific path into the XMP..." alt="AdobeXMPCore::IPath_v1" shape="rect" coords="303,560,596,584"/> +<area href="classAdobeXMPCore_1_1IPathSegment__v1.html" title="Version1 of the interface that represents one segment in a path to a node into the XMP tree..." alt="AdobeXMPCore::IPathSegment_v1" shape="rect" coords="303,616,596,640"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ab90d4ec1fcd975a7ac62dcb866335cdc"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1ISharedObject.html#ab90d4ec1fcd975a7ac62dcb866335cdc">Acquire</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr> +<tr class="memdesc:ab90d4ec1fcd975a7ac62dcb866335cdc"><td class="mdescLeft"> </td><td class="mdescRight">Called by the clients of the object to indicate that he has acquired the shared ownership of the object. <a href="#ab90d4ec1fcd975a7ac62dcb866335cdc">More...</a><br /></td></tr> +<tr class="separator:ab90d4ec1fcd975a7ac62dcb866335cdc"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abf5a54e09f87366170ea19c618f68bc3"><td class="memItemLeft" align="right" valign="top">virtual void APICALL </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1ISharedObject.html#abf5a54e09f87366170ea19c618f68bc3">Release</a> () const <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr> +<tr class="memdesc:abf5a54e09f87366170ea19c618f68bc3"><td class="mdescLeft"> </td><td class="mdescRight">Called by the clients of the object to indicate he has released his shared ownership of the object. If this being the last client than this function should call Destroy to delete and release the memory. <a href="#abf5a54e09f87366170ea19c618f68bc3">More...</a><br /></td></tr> +<tr class="separator:abf5a54e09f87366170ea19c618f68bc3"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> +Protected Member Functions</h2></td></tr> +<tr class="memitem:a5869ff89d0b7dd0a7b525401a1d57b31"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1ISharedObject.html#a5869ff89d0b7dd0a7b525401a1d57b31">~ISharedObject</a> () <a class="el" href="XMPCommonDefines_8h.html#a5a929113d3d50bda3fb7135a5c8b24a2">__NOTHROW__</a>=0</td></tr> +<tr class="separator:a5869ff89d0b7dd0a7b525401a1d57b31"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afcb42109aed83c3b0c133bc413388037"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAdobeXMPCommon_1_1ISharedObject.html#afcb42109aed83c3b0c133bc413388037">REQ_FRIEND_CLASS_DECLARATION</a> ()</td></tr> +<tr class="separator:afcb42109aed83c3b0c133bc413388037"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Interface that serves as the base interface of all the externally exposed interfaces. </p> +<p>This allows all interfaces to be used as shared pointers so as to reduce the burden of scope management from the client or library code. It makes the heap allocated object to be self manged in in terms of memory and life. This provides functions so as to inform the actual object when a shared pointer is created or destroyed and appropriately release the memory during the last call to Release. </p><dl class="section attention"><dt>Attention</dt><dd>Supports Multi-threading at object level through use of Atomic Variables. </dd></dl> +<dl class="section note"><dt>Note</dt><dd>Any interface which inherits from this needs to make sure that its destructor is declared protected so that unknowingly also client of this object cannot call delete on the object. </dd></dl> + +<p>Definition at line <a class="el" href="ISharedObject_8h_source.html#l00027">27</a> of file <a class="el" href="ISharedObject_8h_source.html">ISharedObject.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a5869ff89d0b7dd0a7b525401a1d57b31"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AdobeXMPCommon::ISharedObject::~ISharedObject </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>protected virtual destructor. </p> + +<p>Definition at line <a class="el" href="ISharedObject_8h_source.html#l00067">67</a> of file <a class="el" href="ISharedObject_8h_source.html">ISharedObject.h</a>.</p> +<div class="fragment"><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> { }</div></div><!-- fragment --> +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="ab90d4ec1fcd975a7ac62dcb866335cdc"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void APICALL AdobeXMPCommon::ISharedObject::Acquire </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Called by the clients of the object to indicate that he has acquired the shared ownership of the object. </p> + +</div> +</div> +<a class="anchor" id="abf5a54e09f87366170ea19c618f68bc3"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual void APICALL AdobeXMPCommon::ISharedObject::Release </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Called by the clients of the object to indicate he has released his shared ownership of the object. If this being the last client than this function should call Destroy to delete and release the memory. </p> + +</div> +</div> +<a class="anchor" id="afcb42109aed83c3b0c133bc413388037"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">AdobeXMPCommon::ISharedObject::REQ_FRIEND_CLASS_DECLARATION </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>C:/XMP/XMP-Toolkit-SDK-CC201607/XMP-Toolkit-SDK-CC201607/public/include/XMPCommon/Interfaces/BaseInterfaces/<a class="el" href="ISharedObject_8h_source.html">ISharedObject.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<hr size="1"><address style="text-align: right;"><small> +XMPToolkit documentation generated by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.8.11</small></address> +</body> +</html> |