Software_Type

Bases: NBOBaseClass

Represents the XML complex type Software.

This element represents a commercial, or open-source Software, script, macro, plugin or module utilized for any Image Acquisition or Quality Control task related to this Instrument.

`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

`setID(value)`

Sets the value of the ID attribute.

A Unique Identifier for this component.

Parameters:

Name	Type	Description	Default
`value`	`LSID_Type`	The value to set	required

`getID()`

Returns the value of the ID attribute.

A Unique Identifier for this component.

Returns:

Type	Description
`LSID_Type`	The value of the attribute

`resetID()`

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

`hasID()`

Checks whether the optional ID attribute is present.

A Unique Identifier for this component.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setName(value)`

Sets the value of the Name attribute.

This field records the Name or any other designation the Author uses for this Software.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getName()`

Returns the value of the Name attribute.

This field records the Name or any other designation the Author uses for this Software.

Returns:

Type	Description
`string`	The value of the attribute

`setVersion(value)`

Sets the value of the Version attribute.

This field records the Version of this Software.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getVersion()`

Returns the value of the Version attribute.

This field records the Version of this Software.

Returns:

Type	Description
`string`	The value of the attribute

`setDeveloper(value)`

Sets the value of the Developer attribute.

This field records the Developer(s) of this Software. In case this is a non-commercial, open-source Software, this refers to the name of the individual or consortium who developed the Software. In the case of a commercial Software, this might refer to the Commercial entity but it can also be used to refer to the individual developer, if knonw.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getDeveloper()`

Returns the value of the Developer attribute.

This field records the Developer(s) of this Software. In case this is a non-commercial, open-source Software, this refers to the name of the individual or consortium who developed the Software. In the case of a commercial Software, this might refer to the Commercial entity but it can also be used to refer to the individual developer, if knonw.

Returns:

Type	Description
`string`	The value of the attribute

`setWebsiteURL(value)`

Sets the value of the WebsiteURL attribute.

This field records the URL address of any Website where the Software can be obtained. In case of open-source Software this field should record the URL for the Git repository from which to obtain the source-code.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getWebsiteURL()`

Returns the value of the WebsiteURL attribute.

This field records the URL address of any Website where the Software can be obtained. In case of open-source Software this field should record the URL for the Git repository from which to obtain the source-code.

Returns:

Type	Description
`string`	The value of the attribute

`setPrimaryPublicationID(value)`

Sets the value of the PrimaryPublicationID attribute.

This field captures the a Unique Identifier for the Primary Publication describing this Software. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getPrimaryPublicationID()`

Returns the value of the PrimaryPublicationID attribute.

This field captures the a Unique Identifier for the Primary Publication describing this Software. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Returns:

Type	Description
`string`	The value of the attribute

`resetPrimaryPublicationID()`

Resets the PrimaryPublicationID attribute to an unset state.

This field captures the a Unique Identifier for the Primary Publication describing this Software. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

`hasPrimaryPublicationID()`

Checks whether the optional PrimaryPublicationID attribute is present.

This field captures the a Unique Identifier for the Primary Publication describing this Software. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setOpenSource(value)`

Sets the value of the OpenSource attribute.

This records whether this Software is OpenSource (True) or proprietary (False).

Parameters:

Name	Type	Description	Default
`value`	`boolean`	The value to set	required

`getOpenSource()`

Returns the value of the OpenSource attribute.

This records whether this Software is OpenSource (True) or proprietary (False).

Returns:

Type	Description
`boolean`	The value of the attribute

`resetOpenSource()`

Resets the OpenSource attribute to an unset state.

This records whether this Software is OpenSource (True) or proprietary (False).

`hasOpenSource()`

Checks whether the optional OpenSource attribute is present.

This records whether this Software is OpenSource (True) or proprietary (False).

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setMacro(value)`

Sets the value of the Macro attribute.

This field records whether this Software is a Macro or a Scprit (True) or is it a full free-standing program.

Parameters:

Name	Type	Description	Default
`value`	`boolean`	The value to set	required

`getMacro()`

Returns the value of the Macro attribute.

This field records whether this Software is a Macro or a Scprit (True) or is it a full free-standing program.

Returns:

Type	Description
`boolean`	The value of the attribute

`resetMacro()`

Resets the Macro attribute to an unset state.

This field records whether this Software is a Macro or a Scprit (True) or is it a full free-standing program.

`hasMacro()`

Checks whether the optional Macro attribute is present.

This field records whether this Software is a Macro or a Scprit (True) or is it a full free-standing program.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setBuild(value)`

Sets the value of the Build attribute.

The specific build of this Software.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getBuild()`

Returns the value of the Build attribute.

The specific build of this Software.

Returns:

Type	Description
`string`	The value of the attribute

`resetBuild()`

Resets the Build attribute to an unset state.

The specific build of this Software.

`hasBuild()`

Checks whether the optional Build attribute is present.

The specific build of this Software.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setPatch(value)`

Sets the value of the Patch attribute.

This recodes the version for an optional Patch, HotFix or Update used for this Sofware to run this Instrument. A Patch (aka HotFix, or Update) is a set of changes to a computer program or its supporting data designed to update, fix, or improve it. This includes fixing security vulnerabilities, and other bugs, with such patches usually being called bugfixes or bug fixes, and improving the functionality, usability or performance.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getPatch()`

Returns the value of the Patch attribute.

This recodes the version for an optional Patch, HotFix or Update used for this Sofware to run this Instrument. A Patch (aka HotFix, or Update) is a set of changes to a computer program or its supporting data designed to update, fix, or improve it. This includes fixing security vulnerabilities, and other bugs, with such patches usually being called bugfixes or bug fixes, and improving the functionality, usability or performance.

Returns:

Type	Description
`string`	The value of the attribute

`resetPatch()`

Resets the Patch attribute to an unset state.

This recodes the version for an optional Patch, HotFix or Update used for this Sofware to run this Instrument. A Patch (aka HotFix, or Update) is a set of changes to a computer program or its supporting data designed to update, fix, or improve it. This includes fixing security vulnerabilities, and other bugs, with such patches usually being called bugfixes or bug fixes, and improving the functionality, usability or performance.

`hasPatch()`

Checks whether the optional Patch attribute is present.

This recodes the version for an optional Patch, HotFix or Update used for this Sofware to run this Instrument. A Patch (aka HotFix, or Update) is a set of changes to a computer program or its supporting data designed to update, fix, or improve it. This includes fixing security vulnerabilities, and other bugs, with such patches usually being called bugfixes or bug fixes, and improving the functionality, usability or performance.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setReleaseDate(value)`

Sets the value of the ReleaseDate attribute.

The date in which this Software was resleased.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getReleaseDate()`

Returns the value of the ReleaseDate attribute.

The date in which this Software was resleased.

Returns:

Type	Description
`string`	The value of the attribute

`resetReleaseDate()`

Resets the ReleaseDate attribute to an unset state.

The date in which this Software was resleased.

`hasReleaseDate()`

Checks whether the optional ReleaseDate attribute is present.

The date in which this Software was resleased.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise

`setLanguage(value)`

Sets the value of the Language attribute.

This records the computer Language in which this Software was developed.

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required

`getLanguage()`

Returns the value of the Language attribute.

This records the computer Language in which this Software was developed.

Returns:

Type	Description
`string`	The value of the attribute

`resetLanguage()`

Resets the Language attribute to an unset state.

This records the computer Language in which this Software was developed.

`hasLanguage()`

Checks whether the optional Language attribute is present.

This records the computer Language in which this Software was developed.

Returns:

Type	Description
`boolean`	true if the optional attribute has been set, false otherwise