Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Data Fields
Segment< doubletype > Class Template Reference

#include <Segment.h>

Inheritance diagram for Segment< doubletype >:
Object

Public Member Functions

 Segment ()
 
 Segment (int segment_eid, doubletype segment_x1, doubletype segment_y1, doubletype segment_x2, doubletype segment_y2)
 
 ~Segment ()
 
Objectcopy ()
 
void DeepEcho (void)
 
void Echo (void)
 
int Id (void)
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int ObjectEnum (void)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Data Fields

int eid
 
doubletype x1
 
doubletype y1
 
doubletype x2
 
doubletype y2
 

Detailed Description

template<class doubletype>
class Segment< doubletype >

Definition at line 15 of file Segment.h.

Constructor & Destructor Documentation

◆ Segment() [1/2]

template<class doubletype >
Segment< doubletype >::Segment ( )
inline

Definition at line 25 of file Segment.h.

25  {/*{{{*/
26  this->eid = UNDEF;
27  this->x1 = UNDEF;
28  this->y1 = UNDEF;
29  this->x2 = UNDEF;
30  this->y2 = UNDEF;
31  }

◆ Segment() [2/2]

template<class doubletype >
Segment< doubletype >::Segment ( int  segment_eid,
doubletype  segment_x1,
doubletype  segment_y1,
doubletype  segment_x2,
doubletype  segment_y2 
)
inline

Definition at line 33 of file Segment.h.

33  {/*{{{*/
34 
35  this->eid = segment_eid;
36  this->x1 = segment_x1;
37  this->y1 = segment_y1;
38  this->x2 = segment_x2;
39  this->y2 = segment_y2;
40 
41  }

◆ ~Segment()

template<class doubletype >
Segment< doubletype >::~Segment ( )
inline

Definition at line 43 of file Segment.h.

43  {/*{{{*/
44  }

Member Function Documentation

◆ copy()

template<class doubletype >
Object* Segment< doubletype >::copy ( void  )
inlinevirtual

Implements Object.

Definition at line 48 of file Segment.h.

48  {/*{{{*/
49  return new Segment(this->eid,this->x1,this->y1,this->x2,this->y2);
50  }

◆ DeepEcho()

template<class doubletype >
void Segment< doubletype >::DeepEcho ( void  )
inlinevirtual

Implements Object.

Definition at line 52 of file Segment.h.

52  {/*{{{*/
53  this->Echo();
54  }

◆ Echo()

template<class doubletype >
void Segment< doubletype >::Echo ( void  )
inlinevirtual

Implements Object.

Definition at line 56 of file Segment.h.

56  {/*{{{*/
57 
58  _printf_("Segment:\n");
59  _printf_(" eid: " << eid << "\n");
60  _printf_(" node 1: " << this->x1 << "|" << this->y1 << "\n");
61  _printf_(" node 2: " << this->x2 << "|" << this->y2 << "\n");
62 
63  }

◆ Id()

template<class doubletype >
int Segment< doubletype >::Id ( void  )
inlinevirtual

Implements Object.

Definition at line 65 of file Segment.h.

65 { return eid; }/*{{{*/

◆ Marshall()

template<class doubletype >
void Segment< doubletype >::Marshall ( char **  pmarshalled_data,
int *  pmarshalled_data_size,
int  marshall_direction 
)
inlinevirtual

Implements Object.

Definition at line 67 of file Segment.h.

67  {/*{{{*/
68  _error_("not implemented yet!");
69  }

◆ ObjectEnum()

template<class doubletype >
int Segment< doubletype >::ObjectEnum ( void  )
inlinevirtual

Implements Object.

Definition at line 71 of file Segment.h.

71  {/*{{{*/
72 
73  return SegmentEnum;
74 
75  }

Field Documentation

◆ eid

template<class doubletype >
int Segment< doubletype >::eid

Definition at line 18 of file Segment.h.

◆ x1

template<class doubletype >
doubletype Segment< doubletype >::x1

Definition at line 19 of file Segment.h.

◆ y1

template<class doubletype >
doubletype Segment< doubletype >::y1

Definition at line 20 of file Segment.h.

◆ x2

template<class doubletype >
doubletype Segment< doubletype >::x2

Definition at line 21 of file Segment.h.

◆ y2

template<class doubletype >
doubletype Segment< doubletype >::y2

Definition at line 22 of file Segment.h.


The documentation for this class was generated from the following file:
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
Segment::x1
doubletype x1
Definition: Segment.h:19
UNDEF
#define UNDEF
Definition: constants.h:8
Segment::eid
int eid
Definition: Segment.h:18
Segment::y1
doubletype y1
Definition: Segment.h:20
Segment::y2
doubletype y2
Definition: Segment.h:22
Segment::Segment
Segment()
Definition: Segment.h:25
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
SegmentEnum
@ SegmentEnum
Definition: EnumDefinitions.h:1270
Segment::x2
doubletype x2
Definition: Segment.h:21
Segment::Echo
void Echo(void)
Definition: Segment.h:56