codac
Public Member Functions | Static Public Member Functions | List of all members
codac::DynamicalItem Class Referenceabstract

Abstract class for common properties of Tube, TubeVector, Slice, Trajectory, TrajectoryVector objects. More...

#include <codac_DynamicalItem.h>

Inheritance diagram for codac::DynamicalItem:
Inheritance graph
[legend]

Public Member Functions

virtual ~DynamicalItem ()
 DynamicalItem destructor.
 
virtual int size () const =0
 Returns the dimension of the object. More...
 
virtual const Interval tdomain () const =0
 Returns the temporal definition domain of this object. More...
 
virtual const IntervalVector codomain_box () const =0
 Returns the box of the feasible values along \([t_0,t_f]\). More...
 
virtual const std::string class_name () const =0
 Returns the name of this class. More...
 

Static Public Member Functions

static bool valid_tdomain (const Interval &tdomain)
 Verifies that this interval is a feasible tdomain. More...
 

Detailed Description

Abstract class for common properties of Tube, TubeVector, Slice, Trajectory, TrajectoryVector objects.

Member Function Documentation

◆ size()

virtual int codac::DynamicalItem::size ( ) const
pure virtual

Returns the dimension of the object.

Returns
n

Implemented in codac::TubeVector, codac::Tube, codac::TrajectoryVector, codac::Trajectory, and codac::Slice.

◆ tdomain()

virtual const Interval codac::DynamicalItem::tdomain ( ) const
pure virtual

Returns the temporal definition domain of this object.

Returns
an Interval object \([t_0,t_f]\)

Implemented in codac::TubeVector, codac::Tube, codac::TrajectoryVector, codac::Trajectory, and codac::Slice.

◆ codomain_box()

virtual const IntervalVector codac::DynamicalItem::codomain_box ( ) const
pure virtual

Returns the box of the feasible values along \([t_0,t_f]\).

Note
Used for genericity purposes
Returns
the envelope of codomain values

Implemented in codac::TubeVector, codac::Tube, codac::Slice, codac::TrajectoryVector, and codac::Trajectory.

◆ class_name()

virtual const std::string codac::DynamicalItem::class_name ( ) const
pure virtual

Returns the name of this class.

Note
Only used for some generic display method
Returns
the predefined name

Implemented in codac::TubeVector, codac::Tube, codac::Slice, codac::TrajectoryVector, and codac::Trajectory.

◆ valid_tdomain()

static bool codac::DynamicalItem::valid_tdomain ( const Interval &  tdomain)
static

Verifies that this interval is a feasible tdomain.

Note
The tdomain must be non-empty, bounded and not degenerated
Todo:
Allow unbounded tdomains such as \([t_0,\infty]\)?
Parameters
tdomaintemporal domain \([t_0,t_f]\) to be tested
Returns
true in case of valid temporal tdomain

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