LightPath_Type_InlineLightPathMap
Bases: NBOBaseClass
Represents the XML element LightPathMap.
This element holds a Map that records the order in which the different optical component associated with this Light Path are physically laid out.
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 |
setOpticalComponentPosition_List(value)
Sets the list of OpticalComponentPosition elements.
This element records the Position of individual optical components in this Light Path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
List[LightPath_Type_InlineLightPathMap_InlineOpticalComponentPosition]
|
The new list of OpticalComponentPosition elements |
required |
getOpticalComponentPosition_List()
Returns the list of OpticalComponentPosition elements.
This element records the Position of individual optical components in this Light Path.
Returns:
| Type | Description |
|---|---|
List[LightPath_Type_InlineLightPathMap_InlineOpticalComponentPosition]
|
The list of OpticalComponentPosition elements |
addToOpticalComponentPosition_List(value)
Adds a new OpticalComponentPosition element to this object.
This element records the Position of individual optical components in this Light Path.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
LightPath_Type_InlineLightPathMap_InlineOpticalComponentPosition
|
The element to add |
required |
clearOpticalComponentPosition_List()
Clear the list of OpticalComponentPosition.
This element records the Position of individual optical components in this Light Path.