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.
fromBase ( base )
staticmethod
fromJsonFile ( path , validate = True )
fromJsonString ( json_string , validate = True )
fromXmlFile ( path , validate = True )
fromXmlString ( xml_string , validate = True )
toXmlFile ( filename , validate = True )
toXmlString ( validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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
Resets the MetadataFile attribute to an unset state.
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.
Checks whether the MetadataFile attribute is present.
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
boolean
true if the attribute has been set, false otherwise
Returns the allowed values for this attribut.
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
std::set< str,std::less< str >,std::allocator< str > >
The list of allowed values
setUUID ( value , validate = True )
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
required
validate
(boolean , optional )
If true, validates constraints on value. Default is true.
True
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