BinaryFile
Bases: NBOBaseClass
Represents the XML element BinaryFile.
Size of the uncompressed file. [unit:bytes]
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 |
setFileName(value)
Sets the value of the FileName attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getFileName()
Returns the value of the FileName attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
setSize(value)
Sets the value of the Size attribute.
Size of the uncompressed file. [unit:bytes]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
NonNegativeLong_Type
|
The value to set |
required |
getSize()
Returns the value of the Size attribute.
Size of the uncompressed file. [unit:bytes]
Returns:
| Type | Description |
|---|---|
NonNegativeLong_Type
|
The value of the attribute |
resetSize()
Resets the Size attribute to an unset state.
Size of the uncompressed file. [unit:bytes]
hasSize()
Checks whether the optional Size attribute is present.
Size of the uncompressed file. [unit:bytes]
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMIMEType(value)
Sets the value of the MIMEType attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
string
|
The value to set |
required |
getMIMEType()
Returns the value of the MIMEType attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
string
|
The value of the attribute |
resetMIMEType()
Resets the MIMEType attribute to an unset state.
No description available in the XSD standard.
hasMIMEType()
Checks whether the optional MIMEType attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setbinaryfile_choice(value)
Sets the value of the binaryfile_choice element.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
BinaryFile_Choice
|
The value to set |
required |
getbinaryfile_choice()
Returns the value of the binaryfile_choice element.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
BinaryFile_Choice
|
The value of the element |
resetbinaryfile_choice()
Resets the binaryfile_choice element to an unset state.
No description available in the XSD standard.
hasbinaryfile_choice()
Checks whether the optional binaryfile_choice element is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |