LibrePCB Developers Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GridProperties Class Referencefinal

The GridProperties class. More...

#include <gridproperties.h>

+ Inheritance diagram for GridProperties:
+ Collaboration diagram for GridProperties:

Public Types

enum  Type_t
 

Public Member Functions

 GridProperties () noexcept
 
 GridProperties (const SExpression &node)
 
 GridProperties (Type_t type, const PositiveLength &interval, const LengthUnit &unit) noexcept
 
 GridProperties (const GridProperties &other) noexcept
 
 ~GridProperties () noexcept
 
Type_t getType () const noexcept
 
const PositiveLengthgetInterval () const noexcept
 
const LengthUnitgetUnit () const noexcept
 
void setType (Type_t type) noexcept
 
void setInterval (const PositiveLength &interval) noexcept
 
void setUnit (const LengthUnit &unit) noexcept
 
void serialize (SExpression &root) const override
 Serialize the object into an existing S-Expression node. More...
 
GridPropertiesoperator= (const GridProperties &rhs) noexcept
 
- Public Member Functions inherited from SerializableObject
 SerializableObject () noexcept
 
virtual ~SerializableObject () noexcept
 
SExpression serializeToDomElement (const QString &name) const
 Serialize the object to a new S-Expression node. More...
 

Private Attributes

Type_t mType
 
PositiveLength mInterval
 
LengthUnit mUnit
 

Additional Inherited Members

- Static Public Member Functions inherited from SerializableObject
template<typename T >
static void serializeObjectContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainer (SExpression &root, const T &container, const QString &itemName)
 
template<typename T >
static void serializePointerContainerUuidSorted (SExpression &root, const T &container, const QString &itemName)
 

Detailed Description

The GridProperties class.

Member Enumeration Documentation

enum Type_t
strong
Enumerator
Off 
Lines 
Dots 

Constructor & Destructor Documentation

GridProperties ( )
noexcept
GridProperties ( const SExpression node)
explicit
GridProperties ( Type_t  type,
const PositiveLength interval,
const LengthUnit unit 
)
noexcept
GridProperties ( const GridProperties other)
noexcept
~GridProperties ( )
noexcept

Member Function Documentation

Type_t getType ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const PositiveLength& getInterval ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

const LengthUnit& getUnit ( ) const
inlinenoexcept

+ Here is the caller graph for this function:

void setType ( Type_t  type)
inlinenoexcept

+ Here is the caller graph for this function:

void setInterval ( const PositiveLength interval)
inlinenoexcept

+ Here is the caller graph for this function:

void setUnit ( const LengthUnit unit)
inlinenoexcept

+ Here is the caller graph for this function:

void serialize ( SExpression root) const
overridevirtual

Serialize the object into an existing S-Expression node.

This method inserts/appends all attributes and childs of the object to an existing S-Expression node. The content which already exists in the given S-Expression node will not be removed.

Note
The generated S-Expression node has always the format of the application's major version (it's not possible to generate DOMs of older versions).
Parameters
rootThe target DOM root node
Exceptions
ExceptionThis method throws an exception if an error occurs.

Implements SerializableObject.

+ Here is the call graph for this function:

GridProperties & operator= ( const GridProperties rhs)
noexcept

Member Data Documentation

Type_t mType
private
PositiveLength mInterval
private
LengthUnit mUnit
private

The documentation for this class was generated from the following files: