codac 2.0.0
Loading...
Searching...
No Matches
codac2::TubeBase Class Reference

Base class for tubes defined over a temporal domain. More...

#include <codac2_TubeBase.h>

Inheritance diagram for codac2::TubeBase:

Public Member Functions

 TubeBase (const std::shared_ptr< TDomain > &tdomain)
 Creates a tube over a given temporal domain.
const std::shared_ptr< TDomain > & tdomain () const
 Returns the temporal domain of this tube.
Interval t0_tf () const
 Returns the global temporal interval of this tube.

Protected Attributes

const std::shared_ptr< TDomain_tdomain
 Shared temporal domain of this tube.

Detailed Description

Base class for tubes defined over a temporal domain.

A TubeBase stores the temporal domain shared by a tube. This temporal domain is represented by a TDomain object and defines the global time interval \([t_0,t_f]\) on which the tube is defined.

This class provides common services for all tube types:

  • access to the underlying temporal domain,
  • access to its global temporal interval.

Constructor & Destructor Documentation

◆ TubeBase()

codac2::TubeBase::TubeBase ( const std::shared_ptr< TDomain > & tdomain)
inlineexplicit

Creates a tube over a given temporal domain.

Parameters
tdomainshared temporal domain of this tube
40 {
41 assert_release(tdomain != nullptr);
42 }
const std::shared_ptr< TDomain > _tdomain
Shared temporal domain of this tube.
Definition codac2_TubeBase.h:71
const std::shared_ptr< TDomain > & tdomain() const
Returns the temporal domain of this tube.
Definition codac2_TubeBase.h:49

Member Function Documentation

◆ tdomain()

const std::shared_ptr< TDomain > & codac2::TubeBase::tdomain ( ) const
inline

Returns the temporal domain of this tube.

Returns
shared pointer to the associated TDomain
50 {
51 return _tdomain;
52 }

◆ t0_tf()

Interval codac2::TubeBase::t0_tf ( ) const
inline

Returns the global temporal interval of this tube.

This method is a shortcut to tdomain()->t0_tf().

Returns
temporal interval \([t_0,t_f]\) of this tube
62 {
63 return _tdomain->t0_tf();
64 }

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