Line
Bases: Shape_Type
Represents the XML element Line.
A straight line defined by it's end points.
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 |
setX1(value)
Sets the value of the X1 attribute.
The X coordinate of the start of the line. [units pixels]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getX1()
Returns the value of the X1 attribute.
The X coordinate of the start of the line. [units pixels]
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setY1(value)
Sets the value of the Y1 attribute.
The Y coordinate of the start of the line. [units pixels]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getY1()
Returns the value of the Y1 attribute.
The Y coordinate of the start of the line. [units pixels]
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setX2(value)
Sets the value of the X2 attribute.
The X coordinate of the end of the line. [units pixels]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getX2()
Returns the value of the X2 attribute.
The X coordinate of the end of the line. [units pixels]
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setY2(value)
Sets the value of the Y2 attribute.
The Y coordinate of the end of the line. [units pixels]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
float
|
The value to set |
required |
getY2()
Returns the value of the Y2 attribute.
The Y coordinate of the end of the line. [units pixels]
Returns:
| Type | Description |
|---|---|
float
|
The value of the attribute |
setMarkerStart(value)
Sets the value of the MarkerStart attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Marker_Type
|
The value to set |
required |
getMarkerStart()
Returns the value of the MarkerStart attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
Marker_Type
|
The value of the attribute |
resetMarkerStart()
Resets the MarkerStart attribute to an unset state.
No description available in the XSD standard.
hasMarkerStart()
Checks whether the optional MarkerStart attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |
setMarkerEnd(value)
Sets the value of the MarkerEnd attribute.
No description available in the XSD standard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
Marker_Type
|
The value to set |
required |
getMarkerEnd()
Returns the value of the MarkerEnd attribute.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
Marker_Type
|
The value of the attribute |
resetMarkerEnd()
Resets the MarkerEnd attribute to an unset state.
No description available in the XSD standard.
hasMarkerEnd()
Checks whether the optional MarkerEnd attribute is present.
No description available in the XSD standard.
Returns:
| Type | Description |
|---|---|
boolean
|
true if the optional attribute has been set, false otherwise |