Ctrl+K

Class OutputGrid

Class OutputGrid#

Class Documentation#

class OutputGrid#

OutputGrid MooViE component representation.

Representing a coordinate grid by its dimensional constraints.

Author

beyss

Date

26.07.2017

Public Functions

OutputGrid(const std::vector<DefVariable> &output_vars, const Angle &start, const Angle &end, double radius, double height, Direction dir)#

Creates a OutputGrid presenting given variables and is drawn between given angles with given radius and height.

Parameters:

  • output_vars – a vector containing the output variables

  • start – the start angle

  • end – the end angle

  • radius – the radius from the center

  • height – the height beginning at the radius

  • dir – the Direction the outputs values increase

const DefVariable &get_var(std::size_t num_output) const#

Returns the i-th output variable. If num_output >= num_outputs an exception is thrown.

Parameters:

num_output – the number of the output to return

inline std::size_t get_num_outputs() const#

Returns the total number of stored output variables.

Returns:

the number of outputs

inline const Angle &get_start() const#

Returns the start Angle of this OutputGrid’s drawing span.

Returns:

the start Angle

inline void set_start(const Angle &start)#

Starts the start Angle of this OutputGrid’s drawing span.

Parameters:

start – the start Angle to set

inline const Angle &get_end() const#

Returns the end Angle of this OutputGrid’s drawing span.

Returns:

the end Angle

inline void set_end(const Angle &end)#

Sets the end Angle of this OutputGrid’s drawing span.

Parameters:

end – the end Angle to set

inline double get_radius() const#

Returns the radius measured from the center of the coordinate system.

Returns:

the radius

inline void set_radius(double radius)#

sets the radius

Sets the radius measured from the center of the coordinate system.

Parameters:

radius – the radius to set

inline double get_height() const#

Returns the height measured from the radius.

Returns:

the height

inline void set_height(double height)#

Sets the height measured from the radius.

Parameters:

height – the height to set

inline Direction get_direction() const#

Returns the direction this OutputGrid’s output values increase. The Direction is either COUNTER_CLOCKWISE (with increasing Angle) or CLOCKWISE (with decreasing Angle).

Returns:

the Direction

inline void set_direction(Direction direction)#

Sets the direction this OutputGrid’s output values increase. The Direction is either COUNTER_CLOCKWISE (with increasing Angle) or CLOCKWISE (with decreasing Angle).

Parameters:

direction – the Direction to set

inline const MultiScale &get_scale() const#

Returns the MultiScale of this OutputGrid. This scale instance defines how the graphical scale will be drawn for each output.

Returns:

the MultiScale

Contents