Line¶

Bases: Shape_Type

Represents the XML element Line.

A straight line defined by it's end points.

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a CMOS.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Line`	The casted element, or nullptr if the cast fails

`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, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setX1(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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

`resetX1()` ¶

Resets the X1 attribute to an unset state.

The X coordinate of the start of the line. [units pixels]

`hasX1()` ¶

Checks whether the X1 attribute is present.

The X coordinate of the start of the line. [units pixels]

Returns:

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

`setY1(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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

`resetY1()` ¶

Resets the Y1 attribute to an unset state.

The Y coordinate of the start of the line. [units pixels]

`hasY1()` ¶

Checks whether the Y1 attribute is present.

The Y coordinate of the start of the line. [units pixels]

Returns:

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

`setX2(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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

`resetX2()` ¶

Resets the X2 attribute to an unset state.

The X coordinate of the end of the line. [units pixels]

`hasX2()` ¶

Checks whether the X2 attribute is present.

The X coordinate of the end of the line. [units pixels]

Returns:

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

`setY2(value, validate=True)` ¶

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
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`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

`resetY2()` ¶

Resets the Y2 attribute to an unset state.

The Y coordinate of the end of the line. [units pixels]

`hasY2()` ¶

Checks whether the Y2 attribute is present.

The Y coordinate of the end of the line. [units pixels]

Returns:

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