diff options
Diffstat (limited to 'lib/cosProperty/doc')
28 files changed, 1814 insertions, 0 deletions
diff --git a/lib/cosProperty/doc/html/.gitignore b/lib/cosProperty/doc/html/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/cosProperty/doc/html/.gitignore diff --git a/lib/cosProperty/doc/man3/.gitignore b/lib/cosProperty/doc/man3/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/cosProperty/doc/man3/.gitignore diff --git a/lib/cosProperty/doc/man6/.gitignore b/lib/cosProperty/doc/man6/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/cosProperty/doc/man6/.gitignore diff --git a/lib/cosProperty/doc/pdf/.gitignore b/lib/cosProperty/doc/pdf/.gitignore new file mode 100644 index 0000000000..e69de29bb2 --- /dev/null +++ b/lib/cosProperty/doc/pdf/.gitignore diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertiesIterator.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertiesIterator.xml new file mode 100644 index 0000000000..75c7cb38cb --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertiesIterator.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>CosPropertyService_­PropertiesIterator</title> + <shorttitle>..._PropertiesIterator</shorttitle> + <prepared></prepared> + <docno></docno> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertiesIterator</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertiesIterator interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + </description> + <funcs> + <func> + <name>reset(Iterator) -> ok</name> + <fsummary>Reset the position to the first property</fsummary> + <type> + <v>Iterator = #objref</v> + </type> + <desc> + <p>This operation resets the position to the first property. </p> + </desc> + </func> + <func> + <name>next_one(Iterator) -> Reply</name> + <fsummary>Return true if a Property exists at the current position and the out parameter is a valid Property. Otherwise false and a non-valid property</fsummary> + <type> + <v>Iterator = #objref</v> + <v>Reply = {boolean(), #'CosPropertyService_Property'{property_name = Name, property_value = Value}}</v> + <v>Name = string()</v> + <v>Value = #any</v> + </type> + <desc> + <p>This operation returns true . If false is returned the out + parameter is a non-valid Property.</p> + </desc> + </func> + <func> + <name>next_n(Iterator, HowMany) -> Reply</name> + <fsummary>Return true if the requested number of properties can be delivered and there are additional properties. Otherwise false is returned and a sequence of max <c>HowMany</c>properties</fsummary> + <type> + <v>Iterator = #objref</v> + <v>HowMany = long()</v> + <v>Reply = {boolean(), Properties}</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + </type> + <desc> + <p>This operation returns true if the requested number of properties can be + delivered and there are additional properties. If false is returned and a + sequence of max <c>HowMany</c> properties will be returned and no more + properties can be delivered. </p> + </desc> + </func> + <func> + <name>destroy(Iterator) -> ok</name> + <fsummary>Terminate the target object</fsummary> + <type> + <v>Iterator = #objref</v> + </type> + <desc> + <p>This operation will terminate the Iterator and all subsequent calls + will fail. </p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml new file mode 100644 index 0000000000..54e29a5c01 --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertyNamesIterator.xml @@ -0,0 +1,97 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>CosPropertyService_­PropertyNamesIterator</title> + <shorttitle>..._PropertyNamesIterator</shorttitle> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertyNamesIterator</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertyNamesIterator interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + </description> + <funcs> + <func> + <name>reset(Iterator) -> ok</name> + <fsummary>Reset the position to the first property name</fsummary> + <type> + <v>Iterator = #objref</v> + </type> + <desc> + <p>This operation resets the position to the first property name. </p> + </desc> + </func> + <func> + <name>next_one(Iterator) -> Reply</name> + <fsummary>Return true if a Property Name exists at the current position and the out parameter is a valid Property Name. Otherwise false and a non-valid Property Name</fsummary> + <type> + <v>Iterator = #objref</v> + <v>Reply = {boolean(), Name}</v> + <v>Name = string()</v> + </type> + <desc> + <p>This operation returns true if a Property Name exists at the current + position and the out parameter is a valid Property Name. + If false is returned the out parameter is a non-valid Property Name.</p> + </desc> + </func> + <func> + <name>next_n(Iterator, HowMany) -> Reply</name> + <fsummary>Return <c>HowMany</c>Property Names and a boolean which is true if additional Property Names exists</fsummary> + <type> + <v>Iterator = #objref</v> + <v>HowMany = long()</v> + <v>Reply = {boolean(), [Name]}</v> + <v>Name = string()</v> + </type> + <desc> + <p>This operation returns true if the requested number of Property Names can be + delivered and there are additional property names. If false is returned a + sequence of max <c>HowMany</c> property names will be returned and no + more Property Names can be delivered. </p> + </desc> + </func> + <func> + <name>destroy(Iterator) -> ok</name> + <fsummary>Terminate the target object</fsummary> + <type> + <v>Iterator = #objref</v> + </type> + <desc> + <p>This operation will terminate the Iterator and all subsequent calls + will fail. </p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertySet.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertySet.xml new file mode 100644 index 0000000000..4a2073d88d --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertySet.xml @@ -0,0 +1,201 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>CosPropertyService_­PropertySet</title> + <shorttitle>..._PropertySet</shorttitle> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertySet</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertySet interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + </description> + <funcs> + <func> + <name>define_property(PropertySet, Name, Value) -> Reply</name> + <fsummary>Add a new property to the target object</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Name = non-empty string()</v> + <v>Value = #any</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_ConflictingProperty{}} | {'EXCEPTION', #CosPropertyService_UnsupportedTypeCode{}} | {'EXCEPTION', #CosPropertyService_UnsupportedProperty{}} | {'EXCEPTION', #CosPropertyService_ReadOnlyProperty{}}</v> + </type> + <desc> + <p>This operation adds a new property to the given object. Depending on + which initial arguments was supplied when starting the object several + exceptions may be raised.</p> + </desc> + </func> + <func> + <name>define_properties(PropertySet, Properties) -> Reply</name> + <fsummary>Add new properties to the target object</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}}</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + </type> + <desc> + <p>This operation adds several new properties to the given object. Depending on + which initial arguments was supplied when starting the object an + exceptions may be raised listing the properties failing.</p> + </desc> + </func> + <func> + <name>get_number_of_properties(PropertySet) -> ulong()</name> + <fsummary>Get the number of properties associated with the target object</fsummary> + <type> + <v>PropertySet = #objref</v> + </type> + <desc> + <p>This operation returns the number of properties associated with the target + object.</p> + </desc> + </func> + <func> + <name>get_all_property_names(PropertySet, Max) -> Reply</name> + <fsummary>Get <c>Max</c>property names. If the target object have additional associated properties they will be put in the returned Iterator</fsummary> + <type> + <v>PropertySet = NamesIterator = #objref</v> + <v>Max = ulong()</v> + <v>Reply = {ok, Names, NamesIterator}</v> + <v>Names = [string()]</v> + </type> + <desc> + <p>This operation returns up to <c>Max</c> property names. If the target + object have additional associated properties they will be put in the + returned Iterator, otherwise the Iterator will be a <c>NIL</c> object.</p> + </desc> + </func> + <func> + <name>get_property_value(PropertySet, Name) -> Reply</name> + <fsummary>Return the property value associated with given name</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Name = string()</v> + <v>Reply = #any | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}} | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}</v> + </type> + <desc> + <p>This operation returns the property value associated with given name. If no such property + exists or the given name is an empty string an exception will be raised.</p> + </desc> + </func> + <func> + <name>get_properties(PropertySet, Names) -> Reply</name> + <fsummary>Return all properties associated with given names</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Names = [string()]</v> + <v>Reply = {boolean(), Properties}</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + </type> + <desc> + <p>This operation returns all properties associated with given names. If the + boolean flag is true all properties where retrieved correctly, otherwise, + all properties with the type <c>tk_void</c> was not found.</p> + </desc> + </func> + <func> + <name>get_all_properties(PropertySet, Max) -> Reply</name> + <fsummary>Return a list <c>Max</c>properties or less. If more properties are associated with the target object they will be put in the<c>PropertiesIterator</c>.</fsummary> + <type> + <v>PropertySet = PropertiesIterator = #objref</v> + <v>Reply = {ok, Properties, PropertiesIterator}</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + </type> + <desc> + <p>This operation return a list <c>Max</c> properties or less. If more + properties are associated with the target object they will be put in the + <c>PropertiesIterator</c>. If the object had less than <c>Max</c> + associated properties the Iterator will be a <c>NIL</c> object.</p> + </desc> + </func> + <func> + <name>delete_property(PropertySet, Name) -> Reply</name> + <fsummary>Delete the property with given Name</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Name = string()</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_FixedProperty{}} | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}} | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}</v> + </type> + <desc> + <p>This operation tries to delete the property with given Name. An exception + which indicates why it failed is raised if so needed.</p> + </desc> + </func> + <func> + <name>delete_properties(PropertySet, Names) -> Reply</name> + <fsummary>Delete all properties with given Names</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Names = [string()]</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}}</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + </type> + <desc> + <p>This operation tries to delete all given Properties. If one or more removal + fails an exception is raised which describe why.</p> + </desc> + </func> + <func> + <name>delete_all_properties(PropertySet) -> boolean()</name> + <fsummary>Delete all properties</fsummary> + <type> + <v>PropertySet = #objref</v> + </type> + <desc> + <p>This operation deletes all properties. The boolean flag, if set to false, + indicates that it was not possible to remove one or more properties, e.g., + may be read only.</p> + </desc> + </func> + <func> + <name>is_property_defined(PropertySet, Name) -> Reply</name> + <fsummary>Return true if the target have an associated property with given name</fsummary> + <type> + <v>PropertySet = #objref</v> + <v>Name = non-empty string()</v> + <v>Reply = boolean() | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}}</v> + </type> + <desc> + <p>This operation returns true if the target have an associated property with + given name.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertySetDef.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertySetDef.xml new file mode 100644 index 0000000000..7684998428 --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertySetDef.xml @@ -0,0 +1,168 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>CosPropertyService_­PropertySetDef</title> + <shorttitle>..._PropertySetDef</shorttitle> + <prepared></prepared> + <docno></docno> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertySetDef</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertySetDef interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + <p>This module also exports the functions described in</p> + <p><seealso marker="CosPropertyService_PropertySet">CosPropertyService_PropertySet</seealso></p> + </description> + <funcs> + <func> + <name>get_allowed_property_types(PropertySetDef) -> Reply</name> + <fsummary>Return allowed TypeCodes for the target object</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Reply = {ok, PropertyTypes}</v> + <v>PropertyTypes = [CORBA::TypeCode]</v> + </type> + <desc> + <p>This operation return the TypeCodes which we are allowed to use when adding + new properties.</p> + </desc> + </func> + <func> + <name>get_allowed_properties(PropertySetDef) -> Reply</name> + <fsummary>Return a sequence of the allowed properties</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Reply = {ok, PropertyDefs}</v> + <v>PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + </type> + <desc> + <p>This operation a sequence of the allowed properties we may alter; depends on + which mode associated with a certain property.</p> + </desc> + </func> + <func> + <name>define_property_with_mode(PropertySetDef, Name, Value, Mode) -> Reply</name> + <fsummary>Associate a new property with the target object</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Name = non-empty string()</v> + <v>Value = #any</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_ConflictingProperty{}} | {'EXCEPTION', #CosPropertyService_UnsupportedTypeCode{}} | {'EXCEPTION', #CosPropertyService_UnsupportedProperty{}} | {'EXCEPTION', #CosPropertyService_UnsupportedMode{}} | {'EXCEPTION', #CosPropertyService_ReadOnlyProperty{}}</v> + </type> + <desc> + <p>This operation attempts to associate a new property with the target object. + If we fail to do so the appropriate exception is raised.</p> + </desc> + </func> + <func> + <name>define_properties_with_modes(PropertySetDef, PropertyDefs) -> Reply</name> + <fsummary>Associate the given Property Definitions with the target object</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}}</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + </type> + <desc> + <p>This operation attempts to associate the given Property Definitions with the + target object. If one or more attempts fail an exception is raised + describing which properties we where not able to create.</p> + </desc> + </func> + <func> + <name>get_property_mode(PropertySetDef, Name) -> Reply</name> + <fsummary>Return the mode of the given property</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Name = string()</v> + <v>Reply = Mode | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}}</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + </type> + <desc> + <p>This operation returns the type of the given property.</p> + </desc> + </func> + <func> + <name>get_property_modes(PropertySetDef, Names) -> Reply</name> + <fsummary>Return the modes of the given properties</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Names = [string()]</v> + <v>Reply = {boolean(), PropertyModes}</v> + <v>PropertyModes = [#'CosPropertyService_PropertyMode'{property_name = Name, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + </type> + <desc> + <p>This operation returns the modes of the listed properties. If the boolean + flag is false, all properties with mode <c>undefined</c> this operation + failed to comply.</p> + </desc> + </func> + <func> + <name>set_property_mode(PropertySetDef, Name, Mode) -> Reply</name> + <fsummary>Change the given property's mode</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>Name = string()</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_InvalidPropertyName{}} | {'EXCEPTION', #CosPropertyService_UnsupportedMode{}} | {'EXCEPTION', #CosPropertyService_PropertyNotFound{}}</v> + </type> + <desc> + <p>This operation changes the given property's mode. Return the appropriate + exception if not able to fulfill the request.</p> + </desc> + </func> + <func> + <name>set_property_modes(PropertySetDef, PropertyModes) -> Reply</name> + <fsummary>Change the listed properties mode's</fsummary> + <type> + <v>PropertySetDef = #objref</v> + <v>PropertyModes = [#'CosPropertyService_PropertyMode'{property_name = Name, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = ok | {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}}</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + </type> + <desc> + <p>This operation attempts to update the listed properties mode's. Raises an + exception which describe which and why an operation failed.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertySetDefFactory.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertySetDefFactory.xml new file mode 100644 index 0000000000..82c04e5573 --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertySetDefFactory.xml @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>CosPropertyService_­PropertySetDefFactory</title> + <shorttitle>..._PropertySetDefFactory</shorttitle> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertySetDefFactory</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertySetDefFactory interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + </description> + <funcs> + <func> + <name>create_propertysetdef(Factory) -> </name> + <fsummary>Create a new <c>PropertySetDef</c>with no predefined settings</fsummary> + <type> + <v>Factory = PropertySetDef = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySetDef</c> with no predefined + settings.</p> + </desc> + </func> + <func> + <name>create_constrained_propertysetdef(Factory, PropertyTypes, PropertyDefs) -> Reply</name> + <fsummary>Create a new <c>PropertySetDef</c>with specified constraints</fsummary> + <type> + <v>Factory = PropertySetDef = #objref</v> + <v>PropertyTypes = [CORBA::TypeCode]</v> + <v>PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = {'EXCEPTION', #CosPropertyService_ConstraintNotSupported{}} | PropertySetDef</v> + <v>PropertySetDef = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySetDef</c> with specific + constraints. PropertyTypes states allowed TypeCode's and PropertyDefs valid + <c>CosPropertyService::PropertyDef</c> data.</p> + </desc> + </func> + <func> + <name>create_initial_propertysetdef(Factory, PropertyDefs) -> Reply</name> + <fsummary>Create a new <c>PropertySetDef</c>with specified initial properties</fsummary> + <type> + <v>Factory = PropertySetDef = #objref</v> + <v>PropertyDefs = [#'CosPropertyService_PropertyDef'{property_name = Name, property_value = Value, property_mode = Mode}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Mode = normal | read_only | fixed_normal | fixed_readonly | undefined</v> + <v>Reply = {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}} | PropertySetDef</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + <v>PropertySetDef = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySetDef</c> with specific + initial properties.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml b/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml new file mode 100644 index 0000000000..06b3d2b26d --- /dev/null +++ b/lib/cosProperty/doc/src/CosPropertyService_PropertySetFactory.xml @@ -0,0 +1,93 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year> + <year>2007</year> + <holder>Ericsson AB, All Rights Reserved</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + </legalnotice> + + <title>CosPropertyService_­PropertySetFactory</title> + <shorttitle>..._PropertySetFactory</shorttitle> + <prepared>Niclas Eklund</prepared> + <responsible>Niclas Eklund</responsible> + <docno></docno> + <approved>Niclas Eklund</approved> + <checked></checked> + <date>2000-07-25</date> + <rev>1.0</rev> + </header> + <module>CosPropertyService_PropertySetFactory</module> + <modulesummary>This module implements the OMG CosPropertyService::PropertySetFactory interface.</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/CosPropertyService.hrl").</c></p> + </description> + <funcs> + <func> + <name>create_propertyset(Factory) -> PropertySet</name> + <fsummary>Create a new <c>PropertySe</c>t with no predefined properties</fsummary> + <type> + <v>Factory = PropertySet = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySe</c>t with no predefined + properties.</p> + </desc> + </func> + <func> + <name>create_constrained_propertyset(Factory, PropertyTypes, Properties) -> Reply</name> + <fsummary>Create a new <c>PropertySet</c>with specified constraints</fsummary> + <type> + <v>Factory = #objref</v> + <v>PropertyTypes = [CORBA::TypeCode]</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Reply = {'EXCEPTION', #CosPropertyService_ConstraintNotSupported{}} | PropertySet</v> + <v>PropertySet = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySet</c> with specific constraints. + PropertyTypes states allowed TypeCode's and Properties valid + <c>CosPropertyService::Property</c> data.</p> + </desc> + </func> + <func> + <name>create_initial_propertyset(Factory, Properties) -> Reply</name> + <fsummary>Create a new <c>PropertySet</c>with specified initial properties</fsummary> + <type> + <v>Factory = #objref</v> + <v>Properties = [#'CosPropertyService_Property'{property_name = Name, property_value = Value}]</v> + <v>Name = string()</v> + <v>Value = #any</v> + <v>Reply = {'EXCEPTION', #CosPropertyService_MultipleExceptions{exceptions = Excs}} | PropertySet</v> + <v>Excs = [#'CosPropertyService_PropertyException{reason = Reason, failing_property_name = Name}]</v> + <v>Reason = invalid_property_name | conflicting_property | property_not_found | unsupported_type_code | unsupported_property | unsupported_mode | fixed_property | read_only_property</v> + <v>PropertySet = #objref</v> + </type> + <desc> + <p>This operation creates a new <c>PropertySet</c> with specific + initial properties.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/Makefile b/lib/cosProperty/doc/src/Makefile new file mode 100644 index 0000000000..126e05ef53 --- /dev/null +++ b/lib/cosProperty/doc/src/Makefile @@ -0,0 +1,243 @@ +# +# %CopyrightBegin% +# +# Copyright Ericsson AB 2000-2009. All Rights Reserved. +# +# The contents of this file are subject to the Erlang Public License, +# Version 1.1, (the "License"); you may not use this file except in +# compliance with the License. You should have received a copy of the +# Erlang Public License along with this software. If not, it can be +# retrieved online at http://www.erlang.org/. +# +# Software distributed under the License is distributed on an "AS IS" +# basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +# the License for the specific language governing rights and limitations +# under the License. +# +# %CopyrightEnd% +# +# +include $(ERL_TOP)/make/target.mk +include $(ERL_TOP)/make/$(TARGET)/otp.mk + +# ---------------------------------------------------- +# Application version +# ---------------------------------------------------- +include ../../vsn.mk +VSN=$(COSPROPERTY_VSN) +APPLICATION=cosProperty + +# ---------------------------------------------------- +# Include dependency +# ---------------------------------------------------- + +ifndef DOCSUPPORT +include make.dep +endif + +# ---------------------------------------------------- +# Release directory specification +# ---------------------------------------------------- +RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) + +# ---------------------------------------------------- +# Target Specs +# ---------------------------------------------------- +XML_APPLICATION_FILES = ref_man.xml +XML_REF3_FILES = \ + cosProperty.xml \ + CosPropertyService_PropertySetFactory.xml \ + CosPropertyService_PropertySetDefFactory.xml \ + CosPropertyService_PropertySet.xml \ + CosPropertyService_PropertySetDef.xml \ + CosPropertyService_PropertiesIterator.xml \ + CosPropertyService_PropertyNamesIterator.xml + +XML_REF6_FILES = + +XML_PART_FILES = \ + part.xml \ + part_notes.xml +XML_CHAPTER_FILES = \ + ch_contents.xml \ + ch_introduction.xml \ + ch_install.xml \ + ch_example.xml \ + notes.xml + +BOOK_FILES = book.xml + +TECHNICAL_DESCR_FILES = + +GIF_FILES = \ + book.gif \ + notes.gif \ + ref_man.gif \ + user_guide.gif + +PS_FILES = + +# ---------------------------------------------------- + +INTERNAL_HTML_FILES = $(TECHNICAL_DESCR_FILES:%.xml=$(HTMLDIR)/%.html) + +HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) + +INFO_FILE = ../../info + +EXTRA_FILES = summary.html.src \ + $(DEFAULT_GIF_FILES) \ + $(DEFAULT_HTML_FILES) \ + $(XML_REF3_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_REF6_FILES:%.xml=$(HTMLDIR)/%.html) \ + $(XML_CHAPTER_FILES:%.xml=$(HTMLDIR)/%.html) + +MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) +MAN6_FILES = $(XML_REF6_FILES:%.xml=$(MAN6DIR)/%.6) + + +ifdef DOCSUPPORT + +HTML_REF_MAN_FILE = $(HTMLDIR)/index.html + +TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf + +else + +TEX_FILES_BOOK = \ + $(BOOK_FILES:%.xml=%.tex) +TEX_FILES_REF_MAN = $(XML_REF3_FILES:%.xml=%.tex) \ + $(XML_REF6_FILES:%.xml=%.tex) \ + $(XML_APPLICATION_FILES:%.xml=%.tex) +TEX_FILES_USERS_GUIDE = \ + $(XML_CHAPTER_FILES:%.xml=%.tex) + +TOP_PDF_FILE = $(APPLICATION)-$(VSN).pdf + +TOP_PS_FILE = $(APPLICATION)-$(VSN).ps + +$(TOP_PDF_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< | $(DISTILL) $(DISTILL_FLAGS) > $@ + +$(TOP_PS_FILE): book.dvi ../../vsn.mk + $(DVI2PS) $(DVIPS_FLAGS) -f $< > $@ + +endif + +# ---------------------------------------------------- +# FLAGS +# ---------------------------------------------------- +XML_FLAGS += +DVIPS_FLAGS += + +# ---------------------------------------------------- +# Targets +# ---------------------------------------------------- +$(HTMLDIR)/%.gif: %.gif + $(INSTALL_DATA) $< $@ + +ifdef DOCSUPPORT + +docs: pdf html man + +$(TOP_PDF_FILE): $(XML_FILES) + +pdf: $(TOP_PDF_FILE) + +html: gifs $(HTML_REF_MAN_FILE) + +clean clean_docs: + rm -rf $(HTMLDIR)/* + rm -f $(MAN3DIR)/* + rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) + rm -f errs core *~ + +else + +ifeq ($(DOCTYPE),pdf) +docs: pdf +else +ifeq ($(DOCTYPE),ps) +docs: ps +else +docs: html gifs man +endif +endif + +pdf: $(TOP_PDF_FILE) + +ps: $(TOP_PS_FILE) + +html: $(HTML_FILES) $(INTERNAL_HTML_FILES) + +tex_users_guide: $(TEX_FILES_USERS_GUIDE) +tex_ref_man: $(TEX_FILES_REF_MAN) +tex: tex_users_guide tex_ref_man $(TEX_FILES_BOOK) + +$(DOCDIR)/latexlog: $(BOOK_FILES:%.xml=%.dvi) + -fgrep -i "latex warning" $(BOOK_FILES:%.xml=%.log) >$(DOCDIR)/latexlog + +clean_tex: + -rm -f $(TEX_FILES_USERS_GUIDE) $(TEX_FILES_REF_MAN) $(TEX_FILES_BOOK) + +clean: + rm -f ../html/* $(MAN3_FILES) $(MAN6_FILES) $(TEX_FILES_USERS_GUIDE) + rm -f *xmls_output *xmls_errs + rm -f $(TOP_PDF_FILE) $(TOP_PS_FILE) + rm -f errs core *~ $(LATEX_CLEAN) + +endif + +man: $(MAN3_FILES) $(MAN6_FILES) + +gifs: $(GIF_FILES:%=$(HTMLDIR)/%) + +$(INDEX_TARGET): $(INDEX_SRC) + sed -e 's;%VSN%;$(VSN);' $(INDEX_SRC) > $(INDEX_TARGET) + +debug opt: + +# ---------------------------------------------------- +# Release Target +# ---------------------------------------------------- +include $(ERL_TOP)/make/otp_release_targets.mk + +ifdef DOCSUPPORT + +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELSYSDIR)/doc/pdf + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(HTMLDIR)/* \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3DIR)/* $(RELEASE_PATH)/man/man3 +else + +ifeq ($(DOCTYPE),pdf) +release_docs_spec: pdf + $(INSTALL_DIR) $(RELEASE_PATH)/pdf + $(INSTALL_DATA) $(TOP_PDF_FILE) $(RELEASE_PATH)/pdf +else +ifeq ($(DOCTYPE),ps) +release_docs_spec: ps + $(INSTALL_DIR) $(RELEASE_PATH)/ps + $(INSTALL_DATA) $(TOP_PS_FILE) $(RELEASE_PATH)/ps +else +release_docs_spec: docs + $(INSTALL_DIR) $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(GIF_FILES) $(EXTRA_FILES) $(HTML_FILES) \ + $(RELSYSDIR)/doc/html + $(INSTALL_DATA) $(INFO_FILE) $(RELSYSDIR) + $(INSTALL_DIR) $(RELEASE_PATH)/man/man3 + $(INSTALL_DATA) $(MAN3_FILES) $(RELEASE_PATH)/man/man3 + +endif +endif + +endif + +release_spec: + diff --git a/lib/cosProperty/doc/src/book.gif b/lib/cosProperty/doc/src/book.gif Binary files differnew file mode 100644 index 0000000000..94b3868792 --- /dev/null +++ b/lib/cosProperty/doc/src/book.gif diff --git a/lib/cosProperty/doc/src/book.xml b/lib/cosProperty/doc/src/book.xml new file mode 100644 index 0000000000..f3ba9a5bcd --- /dev/null +++ b/lib/cosProperty/doc/src/book.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE book SYSTEM "book.dtd"> + +<book xmlns:xi="http://www.w3.org/2001/XInclude"> + <header titlestyle="normal"> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>1.0</rev> + </header> + <insidecover> + </insidecover> + <pagetext>cosProperty</pagetext> + <preamble> + <contents level="2"></contents> + </preamble> + <parts lift="no"> + <xi:include href="part.xml"/> + </parts> + <applications> + <xi:include href="ref_man.xml"/> + </applications> + <releasenotes> + <xi:include href="notes.xml"/> + </releasenotes> + <listofterms></listofterms> + <index></index> +</book> + diff --git a/lib/cosProperty/doc/src/ch_contents.xml b/lib/cosProperty/doc/src/ch_contents.xml new file mode 100644 index 0000000000..9b8a39cfb3 --- /dev/null +++ b/lib/cosProperty/doc/src/ch_contents.xml @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>The cosProperty Application</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>1.0</rev> + <file>ch_contents.xml</file> + </header> + + <section> + <title>Content Overview</title> + <p>The cosProperty documentation is divided into three sections: + </p> + <list type="bulleted"> + <item> + <p>PART ONE - The User's Guide + <br></br> +Description of the cosProperty Application including + services and a small tutorial demonstrating + the development of a simple service.</p> + </item> + <item> + <p>PART TWO - Release Notes + <br></br> +A concise history of cosProperty.</p> + </item> + <item> + <p>PART THREE - The Reference Manual + <br></br> + A quick reference guide, including a + brief description, to all the functions available in cosProperty.</p> + </item> + </list> + </section> + + <section> + <title>Brief description of the User's Guide</title> + <p>The User's Guide contains the following parts:</p> + <list type="bulleted"> + <item> + <p>cosProperty overview</p> + </item> + <item> + <p>cosProperty installation</p> + </item> + <item> + <p>A tutorial example</p> + </item> + </list> + </section> +</chapter> + diff --git a/lib/cosProperty/doc/src/ch_example.xml b/lib/cosProperty/doc/src/ch_example.xml new file mode 100644 index 0000000000..3b5c6160fb --- /dev/null +++ b/lib/cosProperty/doc/src/ch_example.xml @@ -0,0 +1,75 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty Examples</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>A</rev> + <file>ch_example.xml</file> + </header> + + <section> + <title>A tutorial on how to create a simple service</title> + + <section> + <title>Initiate the application</title> + <p>To use the cosProperty application Orber must be running.</p> + </section> + + <section> + <title>How to run everything</title> + <p>Below is a short transcript on how to run cosProperty. </p> + <code type="none"> + +%% Start Mnesia and Orber +mnesia:delete_schema([node()]), +mnesia:create_schema([node()]), +orber:install([node()]), +mnesia:start(), +orber:start(), + +%% Install Property Service in the IFR. +cosProperty:install(), + +%% Install Property Service in mnesia. +cosProperty:install_db(), + +%% Now start the application. +cosProperty:start(), + +%% To be able to create Property objects we must first a Factory +%% of our preferred type. +Fac = cosProperty:start_SetDefFactory(), + +%% Now we can create a Property object. +'CosPropertyService_PropertySetDefFactory': + create_propertysetdef(Fac), + +%% Now we can create any allowed properties. There are many +%% options which are all described further in the documentation. + </code> + </section> + </section> +</chapter> + diff --git a/lib/cosProperty/doc/src/ch_install.xml b/lib/cosProperty/doc/src/ch_install.xml new file mode 100644 index 0000000000..33324a0ce6 --- /dev/null +++ b/lib/cosProperty/doc/src/ch_install.xml @@ -0,0 +1,55 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Installing cosProperty</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev></rev> + <file>ch-install.xml</file> + </header> + + <section> + <title>Installation Process</title> + <p>This chapter describes how to install + <seealso marker="cosProperty">cosProperty</seealso> in an Erlang Environment. + </p> + + <section> + <title>Preparation</title> + <p>Before starting the installation process for cosProperty, + the application Orber must be running.</p> + </section> + + <section> + <title>Configuration</title> + <p>First the cosProperty application must be installed by using + <c>cosProperty:install()</c> and, if requested, <c>cosProperty:install_db()</c>, + followed by <c>cosProperty:start()</c>. + Now we can start the desired Factory type by using either + <c>cosProperty:start_SetFactory()</c> or + <c>cosProperty:start_SetDefFactory()</c>.</p> + </section> + </section> +</chapter> + diff --git a/lib/cosProperty/doc/src/ch_introduction.xml b/lib/cosProperty/doc/src/ch_introduction.xml new file mode 100644 index 0000000000..1f8731113a --- /dev/null +++ b/lib/cosProperty/doc/src/ch_introduction.xml @@ -0,0 +1,53 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>Introduction to cosProperty</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev></rev> + <file>ch_introduction.xml</file> + </header> + + <section> + <title>Overview</title> + <p>The cosProperty application is compliant with the <url href="http://www.omg.org">OMG</url> + Service CosProperty Service. + </p> + + <section> + <title>Purpose and Dependencies</title> + <p><em>cosProperty</em> is dependent on <em>Orber</em>, which provides CORBA functionality in an Erlang environment.</p> + </section> + + <section> + <title>Prerequisites</title> + <p>To fully understand the concepts presented in the + documentation, it is recommended that the user is familiar + with distributed programming, CORBA and the Orber application. + </p> + <p>Recommended reading includes <em>CORBA, Fundamentals and Programming - Jon Siegel</em> and <em>Open Telecom Platform Documentation Set</em>. It is also helpful to have read <em>Concurrent Programming in Erlang</em>.</p> + </section> + </section> +</chapter> + diff --git a/lib/cosProperty/doc/src/cosProperty.xml b/lib/cosProperty/doc/src/cosProperty.xml new file mode 100644 index 0000000000..4dbbbad794 --- /dev/null +++ b/lib/cosProperty/doc/src/cosProperty.xml @@ -0,0 +1,149 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE erlref SYSTEM "erlref.dtd"> + +<erlref> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty</title> + <prepared></prepared> + <docno></docno> + <checked></checked> + <date>2000-06-07</date> + <rev>PA1</rev> + </header> + <module>cosProperty</module> + <modulesummary>The main module of the cosProperty application</modulesummary> + <description> + <p>To get access to the record definitions for the structures use: <br></br> +<c>-include_lib("cosProperty/include/*.hrl").</c></p> + <p>This module contains the functions for starting and stopping the application.</p> + </description> + <funcs> + <func> + <name>install() -> Return</name> + <fsummary>Install the cosProperty application in the IFR</fsummary> + <type> + <v>Return = ok | {'EXIT', Reason}</v> + </type> + <desc> + <p>This operation installs the cosProperty application in the IFR.</p> + </desc> + </func> + <func> + <name>install_db() -> Return</name> + <fsummary>Install data in mnesia necessary for running the cosProperty application</fsummary> + <type> + <v>Return = ok | {'EXIT', Reason}</v> + </type> + <desc> + <p>This operation installs data in mnesia necessary for running the + cosProperty application.</p> + </desc> + </func> + <func> + <name>uninstall() -> Return</name> + <fsummary>Remove all data in the IFR related to the cosProperty application</fsummary> + <type> + <v>Return = ok | {'EXIT', Reason}</v> + </type> + <desc> + <p>This operation removes all data in the IFR related to the cosProperty + application.</p> + </desc> + </func> + <func> + <name>uninstall_db() -> Return</name> + <fsummary>Remove all data from mnesia related to the cosProperty application</fsummary> + <type> + <v>Return = ok | {'EXIT', Reason}</v> + </type> + <desc> + <p>This operation removes all data from mnesia related to the cosProperty + application.</p> + </desc> + </func> + <func> + <name>start() -> Return</name> + <fsummary>Start the cosProperty application</fsummary> + <type> + <v>Return = ok | {error, Reason}</v> + </type> + <desc> + <p>This operation starts the cosProperty application.</p> + </desc> + </func> + <func> + <name>start_SetDefFactory() -> Return</name> + <fsummary>Start a PropertySetDef Factory</fsummary> + <type> + <v>Return = Factory | {'EXCEPTION', E}</v> + <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v> + </type> + <desc> + <p>This operation starts a PropertySetDef Factory.</p> + </desc> + </func> + <func> + <name>start_SetFactory() -> Return</name> + <fsummary>Start a PropertySet Factory</fsummary> + <type> + <v>Return = Factory | {'EXCEPTION', E}</v> + <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v> + </type> + <desc> + <p>This operation starts a PropertySet Factory.</p> + </desc> + </func> + <func> + <name>stop_SetDefFactory(Factory) -> Return</name> + <fsummary>Stop the given PropertySetDef Factory</fsummary> + <type> + <v>Factory = CosPropertyService::PropertySetDefFactory reference.</v> + <v>Return = ok | {'EXCEPTION', E}</v> + </type> + <desc> + <p>This operation stops the supplied PropertySetDef Factory.</p> + </desc> + </func> + <func> + <name>stop_SetFactory(Factory) -> Return</name> + <fsummary>Stop the given PropertySet Factory</fsummary> + <type> + <v>Factory = CosPropertyService::PropertySetFactory reference.</v> + <v>Return = ok | {'EXCEPTION', E}</v> + </type> + <desc> + <p>This operation stops the supplied PropertySet Factory.</p> + </desc> + </func> + <func> + <name>stop() -> Return</name> + <fsummary>Stop the cosProperty application</fsummary> + <type> + <v>Return = ok | {error, Reason}</v> + </type> + <desc> + <p>This operation stops the cosProperty application.</p> + </desc> + </func> + </funcs> + +</erlref> + diff --git a/lib/cosProperty/doc/src/fascicules.xml b/lib/cosProperty/doc/src/fascicules.xml new file mode 100644 index 0000000000..0678195e07 --- /dev/null +++ b/lib/cosProperty/doc/src/fascicules.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE fascicules SYSTEM "fascicules.dtd"> + +<fascicules> + <fascicule file="part" href="part_frame.html" entry="no"> + User's Guide + </fascicule> + <fascicule file="ref_man" href="ref_man_frame.html" entry="yes"> + Reference Manual + </fascicule> + <fascicule file="part_notes" href="part_notes_frame.html" entry="no"> + Release Notes + </fascicule> + <fascicule file="" href="../../../../doc/print.html" entry="no"> + Off-Print + </fascicule> +</fascicules> + diff --git a/lib/cosProperty/doc/src/make.dep b/lib/cosProperty/doc/src/make.dep new file mode 100644 index 0000000000..383af54244 --- /dev/null +++ b/lib/cosProperty/doc/src/make.dep @@ -0,0 +1,26 @@ +# ---------------------------------------------------- +# >>>> Do not edit this file <<<< +# This file was automaticly generated by +# /home/otp/bin/docdepend +# ---------------------------------------------------- + + +# ---------------------------------------------------- +# TeX files that the DVI file depend on +# ---------------------------------------------------- + +book.dvi: CosPropertyService_PropertiesIterator.tex \ + CosPropertyService_PropertyNamesIterator.tex \ + CosPropertyService_PropertySet.tex CosPropertyService_PropertySetDef.tex \ + CosPropertyService_PropertySetDefFactory.tex \ + CosPropertyService_PropertySetFactory.tex \ + book.tex ch_contents.tex ch_example.tex ch_install.tex \ + ch_introduction.tex cosProperty.tex part.tex \ + ref_man.tex + +# ---------------------------------------------------- +# Source inlined when transforming from source to LaTeX +# ---------------------------------------------------- + +book.tex: ref_man.xml + diff --git a/lib/cosProperty/doc/src/notes.gif b/lib/cosProperty/doc/src/notes.gif Binary files differnew file mode 100644 index 0000000000..e000cca26a --- /dev/null +++ b/lib/cosProperty/doc/src/notes.gif diff --git a/lib/cosProperty/doc/src/notes.xml b/lib/cosProperty/doc/src/notes.xml new file mode 100644 index 0000000000..be3a8d0f5e --- /dev/null +++ b/lib/cosProperty/doc/src/notes.xml @@ -0,0 +1,206 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE chapter SYSTEM "chapter.dtd"> + +<chapter> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty Release Notes</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <approved></approved> + <checked></checked> + <date>2000-06-07</date> + <rev>A</rev> + <file>notes.xml</file> + </header> + + <section> + <title>cosProperty 1.1.10</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p> + The documentation is now built with open source tools (xsltproc and fop) + that exists on most platforms. One visible change is that the frames are removed.</p> + <p> + Own Id: OTP-8201 Aux Id:</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.9</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Obsolete guards, e.g. record vs is_record, has been changed + to avoid compiler warnings.</p> + <p>Own id: OTP-7987</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.8</title> + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Updated file headers.</p> + <p>Own id: OTP-7837</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.7</title> + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Documentation source included in open source releases.</p> + <p>Own id: OTP-7595</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.6</title> + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Updated file headers.</p> + <p>Own id: OTP-7011</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.5</title> + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>The documentation source has been converted from SGML to XML.</p> + <p>Own Id: OTP-6754 Aux Id: </p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.4</title> + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Minor Makefile changes.</p> + <p>Own Id: OTP-6701 Aux Id: </p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.3</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>The appup source file was missing a trailing newline.</p> + <p>Own id: OTP-6626</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.2</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>Removed some unused code.</p> + <p>Own Id: OTP-6527 Aux Id: </p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1.1</title> + + <section> + <title>Fixed Bugs and Malfunctions</title> + <list type="bulleted"> + <item> + <p>The app-file contained duplicated modules.</p> + <p>Own id: OTP-4976</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>The stub/skeleton-files generated by IC have been improved, + i.e., depending on the IDL-files, reduced the size of the + erl- and beam-files and decreased dependencies off Orber's + Interface Repository. It is necessary to re-compile all IDL-files + and use COS-applications, including Orber, compiled with + IC-4.2.</p> + <p>Own id: OTP-4576</p> + </item> + </list> + </section> + </section> + + <section> + <title>cosProperty 1.0.1</title> + + <section> + <title>Improvements and New Features</title> + <list type="bulleted"> + <item> + <p>First release of the cosProperty application.</p> + <p>Own Id: -</p> + </item> + </list> + </section> + </section> +</chapter> + diff --git a/lib/cosProperty/doc/src/part.xml b/lib/cosProperty/doc/src/part.xml new file mode 100644 index 0000000000..210dad6920 --- /dev/null +++ b/lib/cosProperty/doc/src/part.xml @@ -0,0 +1,39 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty User's Guide</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>1.0</rev> + </header> + <description> + <p>The cosProperty Application is an Erlang implementation of the OMG + CORBA Property Service.</p> + </description> + <xi:include href="ch_contents.xml"/> + <xi:include href="ch_introduction.xml"/> + <xi:include href="ch_install.xml"/> + <xi:include href="ch_example.xml"/> +</part> + diff --git a/lib/cosProperty/doc/src/part_notes.xml b/lib/cosProperty/doc/src/part_notes.xml new file mode 100644 index 0000000000..4e02ff4e55 --- /dev/null +++ b/lib/cosProperty/doc/src/part_notes.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE part SYSTEM "part.dtd"> + +<part xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty Release Notes</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>1.0</rev> + </header> + <description> + <p>The cosProperty Application is an Erlang implementation of the OMG + CORBA Property Service.</p> + </description> + <xi:include href="notes.xml"/> +</part> + diff --git a/lib/cosProperty/doc/src/ref_man.gif b/lib/cosProperty/doc/src/ref_man.gif Binary files differnew file mode 100644 index 0000000000..b13c4efd53 --- /dev/null +++ b/lib/cosProperty/doc/src/ref_man.gif diff --git a/lib/cosProperty/doc/src/ref_man.xml b/lib/cosProperty/doc/src/ref_man.xml new file mode 100644 index 0000000000..f69904e42f --- /dev/null +++ b/lib/cosProperty/doc/src/ref_man.xml @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="latin1" ?> +<!DOCTYPE application SYSTEM "application.dtd"> + +<application xmlns:xi="http://www.w3.org/2001/XInclude"> + <header> + <copyright> + <year>2000</year><year>2009</year> + <holder>Ericsson AB. All Rights Reserved.</holder> + </copyright> + <legalnotice> + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + </legalnotice> + + <title>cosProperty Reference Manual</title> + <prepared>Niclas Eklund</prepared> + <docno></docno> + <date>2000-06-07</date> + <rev>1.0</rev> + </header> + <description> + <p>The cosProperty Application is an Erlang implementation of the OMG + CORBA Property Service.</p> + </description> + <xi:include href="cosProperty.xml"/> + <xi:include href="CosPropertyService_PropertySetFactory.xml"/> + <xi:include href="CosPropertyService_PropertySetDefFactory.xml"/> + <xi:include href="CosPropertyService_PropertySet.xml"/> + <xi:include href="CosPropertyService_PropertySetDef.xml"/> + <xi:include href="CosPropertyService_PropertiesIterator.xml"/> + <xi:include href="CosPropertyService_PropertyNamesIterator.xml"/> +</application> + diff --git a/lib/cosProperty/doc/src/summary.html.src b/lib/cosProperty/doc/src/summary.html.src new file mode 100644 index 0000000000..87370c659c --- /dev/null +++ b/lib/cosProperty/doc/src/summary.html.src @@ -0,0 +1 @@ +Orber OMG Property Service.
\ No newline at end of file diff --git a/lib/cosProperty/doc/src/user_guide.gif b/lib/cosProperty/doc/src/user_guide.gif Binary files differnew file mode 100644 index 0000000000..e6275a803d --- /dev/null +++ b/lib/cosProperty/doc/src/user_guide.gif |
