ExtendedSummary_Frame Class Reference

#include <TimeSlice.hh>

Inheritance diagram for ExtendedSummary_Frame:

Public Types
typedef void	item_type
	item type definition

Public Member Functions
const unsigned short	numberOfItemsOrg () const
	get number of items original
	ExtendedSummary_Frame ()
	Default constructor.
ExtendedSummary_Frame &	operator+= (const ExtendedSummary_Frame &object)
	operator +=
	ClassDef (ExtendedSummary_Frame, 2)
	ROOT class definition.
const unsigned short	numberOfItemsOrg () const
	get number of items original
	ExtendedSummary_Frame ()
	Default constructor.
ExtendedSummary_Frame &	operator+= (const ExtendedSummary_Frame &object)
	operator +=
	ClassDef (ExtendedSummary_Frame, 2)
	ROOT class definition.
const unsigned short	lcm_id () const
	get LCM idendifier
const unsigned short	lcm_id () const
	get LCM idendifier
const unsigned char	ars_id () const
	get ARS idendifier
const unsigned char	ars_id () const
	get ARS idendifier
const unsigned char	data_type () const
	get data type
const unsigned char	data_type () const
	get data type
const unsigned short	numberOfItems () const
	get number of items
const unsigned short	numberOfItems () const
	get number of items
const bool	operator== (const Summary_Frame &object)
	equal operator.
const bool	operator== (const Summary_Frame &object)
	equal operator.
const bool	operator!= (const Summary_Frame &object) const
	not-equal operator.
const bool	operator!= (const Summary_Frame &object) const
	not-equal operator.
const bool	operator< (const Summary_Frame &object) const
	less than operator.
const bool	operator< (const Summary_Frame &object) const
	less than operator.
Summary_Frame &	operator+= (const Summary_Frame &object)
	operator +=
	ClassDef (Summary_Frame, 2)
	ROOT class definition.

Protected Attributes
unsigned short	numberOfItemsOrg_
	number of items original
unsigned short	lcm_id_
	LCM identifier.
unsigned char	ars_id_
	ARS identifier.
unsigned char	data_type_
	data type
unsigned short	numberOfItems_
	number of items

Friends
std::ostream &	operator<< (std::ostream &out, const ExtendedSummary_Frame &object)
	Print ASCII.
std::ostream &	operator<< (std::ostream &out, const ExtendedSummary_Frame &object)
	Print ASCII.

Detailed Description

Definition at line 157 of file build/antares-dataformat/TimeSlice.hh.

Member Typedef Documentation

item_type

typedef void ExtendedSummary_Frame::item_type

item type definition

Definition at line 168 of file build/antares-dataformat/TimeSlice.hh.

Constructor & Destructor Documentation

ExtendedSummary_Frame() [1/2]

ExtendedSummary_Frame::ExtendedSummary_Frame ( )

inline

Default constructor.

Definition at line 179 of file build/antares-dataformat/TimeSlice.hh.

                          :
    Summary_Frame(),
    numberOfItemsOrg_(0)
  {}

ExtendedSummary_Frame() [2/2]

ExtendedSummary_Frame::ExtendedSummary_Frame ( )

inline

Default constructor.

Definition at line 179 of file TimeSlice.hh.

                          :
    Summary_Frame(),
    numberOfItemsOrg_(0)
  {}

Member Function Documentation

numberOfItemsOrg() [1/2]

const unsigned short ExtendedSummary_Frame::numberOfItemsOrg ( ) const

inline

get number of items original

Returns

number of items

Definition at line 174 of file build/antares-dataformat/TimeSlice.hh.

{ return numberOfItemsOrg_; }

operator+=() [1/3]

ExtendedSummary_Frame & ExtendedSummary_Frame::operator+= ( const ExtendedSummary_Frame & object )

inline

operator +=

Parameters

object

extended summary frame

Returns

this extended summary frame

Definition at line 208 of file build/antares-dataformat/TimeSlice.hh.

  {
    if (*this == object) {
      numberOfItems_    += object.numberOfItems_;
      numberOfItemsOrg_ += object.numberOfItemsOrg_;
    }
    return *this;
  }

ClassDef() [1/3]

ExtendedSummary_Frame::ClassDef	(	ExtendedSummary_Frame	,
		2	)

ROOT class definition.

numberOfItemsOrg() [2/2]

const unsigned short ExtendedSummary_Frame::numberOfItemsOrg ( ) const

inline

get number of items original

Returns

number of items

Definition at line 174 of file TimeSlice.hh.

{ return numberOfItemsOrg_; }

operator+=() [2/3]

ExtendedSummary_Frame & ExtendedSummary_Frame::operator+= ( const ExtendedSummary_Frame & object )

inline

operator +=

Parameters

object

extended summary frame

Returns

this extended summary frame

Definition at line 208 of file TimeSlice.hh.

  {
    if (*this == object) {
      numberOfItems_    += object.numberOfItems_;
      numberOfItemsOrg_ += object.numberOfItemsOrg_;
    }
    return *this;
  }

ClassDef() [2/3]

ExtendedSummary_Frame::ClassDef	(	ExtendedSummary_Frame	,
		2	)

ROOT class definition.

lcm_id() [1/2]

const unsigned short Summary_Frame::lcm_id ( ) const

inlineinherited

get LCM idendifier

Returns

LCM identifier

Definition at line 42 of file build/antares-dataformat/TimeSlice.hh.

{ return lcm_id_; }

lcm_id() [2/2]

const unsigned short Summary_Frame::lcm_id ( ) const

inlineinherited

get LCM idendifier

Returns

LCM identifier

Definition at line 42 of file TimeSlice.hh.

{ return lcm_id_; }

ars_id() [1/2]

const unsigned char Summary_Frame::ars_id ( ) const

inlineinherited

get ARS idendifier

Returns

ARS identifier

Definition at line 48 of file build/antares-dataformat/TimeSlice.hh.

{ return ars_id_; }

ars_id() [2/2]

const unsigned char Summary_Frame::ars_id ( ) const

inlineinherited

get ARS idendifier

Returns

ARS identifier

Definition at line 48 of file TimeSlice.hh.

{ return ars_id_; }

data_type() [1/2]

const unsigned char Summary_Frame::data_type ( ) const

inlineinherited

get data type

Returns

data type

Definition at line 54 of file build/antares-dataformat/TimeSlice.hh.

{ return data_type_; }

data_type() [2/2]

const unsigned char Summary_Frame::data_type ( ) const

inlineinherited

get data type

Returns

data type

Definition at line 54 of file TimeSlice.hh.

{ return data_type_; }

numberOfItems() [1/2]

const unsigned short Summary_Frame::numberOfItems ( ) const

inlineinherited

get number of items

Returns

number of items

Definition at line 60 of file build/antares-dataformat/TimeSlice.hh.

{ return numberOfItems_; }

numberOfItems() [2/2]

const unsigned short Summary_Frame::numberOfItems ( ) const

inlineinherited

get number of items

Returns

number of items

Definition at line 60 of file TimeSlice.hh.

{ return numberOfItems_; }

operator==() [1/2]

const bool Summary_Frame::operator== ( const Summary_Frame & object )

inlineinherited

equal operator.

Parameters

object

summary frame

Returns

true if equals object; else false

Definition at line 83 of file build/antares-dataformat/TimeSlice.hh.

  {
    return (lcm_id_    == object.lcm_id_   &&
            ars_id_    == object.ars_id_   &&
            data_type_ == object.data_type_);
  }

operator==() [2/2]

const bool Summary_Frame::operator== ( const Summary_Frame & object )

inlineinherited

equal operator.

Parameters

object

summary frame

Returns

true if equals object; else false

Definition at line 83 of file TimeSlice.hh.

  {
    return (lcm_id_    == object.lcm_id_   &&
            ars_id_    == object.ars_id_   &&
            data_type_ == object.data_type_);
  }

operator!=() [1/2]

const bool Summary_Frame::operator!= ( const Summary_Frame & object ) const

inlineinherited

not-equal operator.

Parameters

object

summary frame

Returns

true if not equals object; else false

Definition at line 96 of file build/antares-dataformat/TimeSlice.hh.

  {
    return (lcm_id_    != object.lcm_id_   ||
            ars_id_    != object.ars_id_   ||
            data_type_ != object.data_type_);
  }

operator!=() [2/2]

const bool Summary_Frame::operator!= ( const Summary_Frame & object ) const

inlineinherited

not-equal operator.

Parameters

object

summary frame

Returns

true if not equals object; else false

Definition at line 96 of file TimeSlice.hh.

  {
    return (lcm_id_    != object.lcm_id_   ||
            ars_id_    != object.ars_id_   ||
            data_type_ != object.data_type_);
  }

operator<() [1/2]

const bool Summary_Frame::operator< ( const Summary_Frame & object ) const

inlineinherited

less than operator.

Parameters

object

summary frame

Returns

true if less than object; else false

Definition at line 109 of file build/antares-dataformat/TimeSlice.hh.

  {
    if (lcm_id_ == object.lcm_id_)
      if (ars_id_ == object.ars_id_)
        return data_type_ < object.data_type_;
      else
        return ars_id_ < object.ars_id_;
    else
      return lcm_id_ < object.lcm_id_;
  }

operator<() [2/2]

const bool Summary_Frame::operator< ( const Summary_Frame & object ) const

inlineinherited

less than operator.

Parameters

object

summary frame

Returns

true if less than object; else false

Definition at line 109 of file TimeSlice.hh.

  {
    if (lcm_id_ == object.lcm_id_)
      if (ars_id_ == object.ars_id_)
        return data_type_ < object.data_type_;
      else
        return ars_id_ < object.ars_id_;
    else
      return lcm_id_ < object.lcm_id_;
  }

operator+=() [3/3]

Summary_Frame & Summary_Frame::operator+= ( const Summary_Frame & object )

inlineinherited

operator +=

Parameters

object

summar frame

Returns

this summay frame

Definition at line 143 of file build/antares-dataformat/TimeSlice.hh.

  {
    if (*this == object) {
      numberOfItems_ += object.numberOfItems_;
    }
    
    return *this;
  }

ClassDef() [3/3]

Summary_Frame::ClassDef ( Summary_Frame , 2  )

inherited

ROOT class definition.

Friends And Related Symbol Documentation

operator<< [1/2]

std::ostream & operator<< ( std::ostream & out, const ExtendedSummary_Frame & object )

friend

Print ASCII.

Parameters

out	output stream
object	Extended Summary frame

Returns

output stream

Definition at line 191 of file build/antares-dataformat/TimeSlice.hh.

  {
    using namespace std;
    
    return out << setw(5) << (int) object.lcm_id_           << ' ' 
               << setw(2) << (int) object.ars_id_           << ' ' 
               << setw(2) << (int) object.data_type_        << ' ' 
               << setw(5) << (int) object.numberOfItems_    << ' '
               << setw(5) << (int) object.numberOfItemsOrg_ << endl;
  }

operator<< [2/2]

std::ostream & operator<< ( std::ostream & out, const ExtendedSummary_Frame & object )

friend

Print ASCII.

Parameters

out	output stream
object	Extended Summary frame

Returns

output stream

Definition at line 191 of file TimeSlice.hh.

  {
    using namespace std;
    
    return out << setw(5) << (int) object.lcm_id_           << ' ' 
               << setw(2) << (int) object.ars_id_           << ' ' 
               << setw(2) << (int) object.data_type_        << ' ' 
               << setw(5) << (int) object.numberOfItems_    << ' '
               << setw(5) << (int) object.numberOfItemsOrg_ << endl;
  }

Member Data Documentation

numberOfItemsOrg_

unsigned short ExtendedSummary_Frame::numberOfItemsOrg_

protected

number of items original

Definition at line 162 of file build/antares-dataformat/TimeSlice.hh.

lcm_id_

unsigned short Summary_Frame::lcm_id_

protectedinherited

LCM identifier.

Definition at line 24 of file build/antares-dataformat/TimeSlice.hh.

ars_id_

unsigned char Summary_Frame::ars_id_

protectedinherited

ARS identifier.

Definition at line 26 of file build/antares-dataformat/TimeSlice.hh.

data_type_

unsigned char Summary_Frame::data_type_

protectedinherited

data type

Definition at line 28 of file build/antares-dataformat/TimeSlice.hh.

numberOfItems_

unsigned short Summary_Frame::numberOfItems_

protectedinherited

number of items

Definition at line 30 of file build/antares-dataformat/TimeSlice.hh.

---

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

• build/antares-dataformat/TimeSlice.hh
• TimeSlice.hh