Rights¶
Bases: NBOBaseClass
Represents the XML element Rights.
The rights holder of this data and the rights held.
fromBase(base)
staticmethod
¶
Cast a NBOBaseClass to a CMOS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
base
|
NBOBaseClass
|
The base class to cast |
required |
Returns:
| Type | Description |
|---|---|
Rights
|
The casted element, or nullptr if the cast fails |
getTypeName()
¶
Returns the class type name.
Returns:
| Type | Description |
|---|---|
string
|
The class type name |
getXMLName()
¶
Returns the XML element name corresponding to this class.
Returns:
| Type | Description |
|---|---|
string
|
The XML element name |
getNBOType()
¶
Returns the NBO Type corresponding to this class.
Returns:
| Type | Description |
|---|---|
int
|
The NBO Type value |
getChildren()
¶
Returns a list of all classes derived from this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of derived classes |
getSubElements()
¶
Returns a list of all child elements contained in this class.
Returns:
| Type | Description |
|---|---|
List[NBOBaseClass]
|
The list of child classes |
fromJsonFile(path, validate=True)
¶
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromJsonString(json_string, validate=True)
¶
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromXmlFile(path, validate=True)
¶
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
fromXmlString(xml_string, validate=True)
¶
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
toXmlFile(filename, validate=True)
¶
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
toXmlString(validate=True)
¶
Serializes this object to an XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setRightsHolder(value, validate=True)
¶
Sets the value of the RightsHolder element.
The rights holder for this data. [plain-text multi-line string] e.g..... "Copyright (C) 2002 - 2016 Open Microscopy Environment"
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Rights_InlineRightsHolder
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getRightsHolder()
¶
Returns the value of the RightsHolder element.
The rights holder for this data. [plain-text multi-line string] e.g..... "Copyright (C) 2002 - 2016 Open Microscopy Environment"
Returns:
| Type | Description |
|---|---|
Rights_InlineRightsHolder
|
The value of the element |
resetRightsHolder()
¶
Resets the RightsHolder element to an unset state.
The rights holder for this data. [plain-text multi-line string] e.g..... "Copyright (C) 2002 - 2016 Open Microscopy Environment"
hasRightsHolder()
¶
Checks whether the optional RightsHolder element is present.
The rights holder for this data. [plain-text multi-line string] e.g..... "Copyright (C) 2002 - 2016 Open Microscopy Environment"
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setRightsHeld(value, validate=True)
¶
Sets the value of the RightsHeld element.
The rights held by the rights holder. [plain-text multi-line string] e.g..... "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Rights_InlineRightsHeld
|
The value to set |
required |
validate
|
(boolean, optional)
|
If true, validates constraints on value. Default is true. |
True
|
getRightsHeld()
¶
Returns the value of the RightsHeld element.
The rights held by the rights holder. [plain-text multi-line string] e.g..... "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"
Returns:
| Type | Description |
|---|---|
Rights_InlineRightsHeld
|
The value of the element |
resetRightsHeld()
¶
Resets the RightsHeld element to an unset state.
The rights held by the rights holder. [plain-text multi-line string] e.g..... "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"
hasRightsHeld()
¶
Checks whether the optional RightsHeld element is present.
The rights held by the rights holder. [plain-text multi-line string] e.g..... "All rights reserved" or "Creative Commons Attribution 3.0 Unported License"
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |