en/v0.1.0/segment_8h_source.html

 #ifndef SEGMENT_H
 #define SEGMENT_H

 #include <string>
 #include "fields/field.h"
 #include "global.h"

 class Segment : public Field{
 private:
     int startSegment;
     int endSegment;
 public:
     Segment(int, int);
     bool operator==(const Segment &other);
     int length();
     bool isIntersecting(const Segment &other);
     FieldType getType();
     std::string getName();
     std::string getTypeName();
 };

 #endif
Segment::getType
FieldType getType()
Gets the type under the FieldType enum.
Definition: segment.cpp:68

Field
Class for a field.
Definition: field.h:14

Segment::isIntersecting
bool isIntersecting(const Segment &other)
Determines if two Segments are intersecting. Two segments are said to be intersecting if they contain...
Definition: segment.cpp:53

global.h

Segment::operator==
bool operator==(const Segment &other)
Checks if two segment objects are identical, which is if their start and end segments are identical...
Definition: segment.cpp:28

Segment::length
int length()
Gets the length of the Segment, which is the number of segment units it represents. For example, the length of the Segment 16 is 6.
Definition: segment.cpp:39

Segment::Segment
Segment(int, int)
Constructs the Segment object.
Definition: segment.cpp:14

Segment::getTypeName
std::string getTypeName()
Gets the type name, which is "Segment".
Definition: segment.cpp:88

FieldType
FieldType
Enum that represents all the field types.
Definition: global.h:10

Segment::getName
std::string getName()
Gets the name of the Segment. The name is a string that concatenates the start and end segment values...
Definition: segment.cpp:79

Segment
Class for segment.
Definition: segment.h:13

field.h