OME_Choice_InlineBinaryOnly
Bases: NBOBaseClass
Represents the XML element BinaryOnly.
Pointer to an external metadata file. If this element is present, then no other metadata may be present in this file, i.e. this file is a place-holder.
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)
Populates this object from a JSON file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the JSON file |
required |
fromJsonString(json_string)
Populates this object from a JSON string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
json_string
|
string
|
The JSON content as a string |
required |
fromXmlFile(path)
Populates this object from a XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
string
|
The path to the XML file |
required |
fromXmlString(xml_string)
Populates this object from a XML string.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xml_string
|
string
|
The XML content as a string |
required |
toXmlFile(filename)
Serializes this object to an XML file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
filename
|
string
|
The path to the output XML file |
required |
toXmlString()
Serializes this object to an XML string.
Returns:
| Type | Description |
|---|---|
string
|
A string containing the XML representation of this object |
setMetadataFile(value)
Sets the value of the MetadataFile attribute.
Filename of the OME-XML metadata file for this binary data. If the file cannot be found, a search can be performed based on the UUID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getMetadataFile()
Returns the value of the MetadataFile attribute.
Filename of the OME-XML metadata file for this binary data. If the file cannot be found, a search can be performed based on the UUID.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
setUUID(value)
Sets the value of the UUID attribute.
The unique identifier of another OME-XML block whose metadata describes the binary data in this file. This UUID is considered authoritative regardless of mismatches in the filename.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
UniversallyUniqueIdentifier_Type
|
The value to set |
required |
getUUID()
Returns the value of the UUID attribute.
The unique identifier of another OME-XML block whose metadata describes the binary data in this file. This UUID is considered authoritative regardless of mismatches in the filename.
Returns:
| Type | Description |
|---|---|
UniversallyUniqueIdentifier_Type
|
The value of the attribute |
resetUUID()
Resets the UUID attribute to an unset state.
The unique identifier of another OME-XML block whose metadata describes the binary data in this file. This UUID is considered authoritative regardless of mismatches in the filename.
hasUUID()
Checks whether the optional UUID attribute is present.
The unique identifier of another OME-XML block whose metadata describes the binary data in this file. This UUID is considered authoritative regardless of mismatches in the filename.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |