dtn::data::PrimaryFlags Class Reference

#include <PrimaryFlags.h>

Inheritance diagram for dtn::data::PrimaryFlags:

List of all members.

Public Member Functions
	PrimaryFlags ()
	PrimaryFlags (unsigned int value)
virtual	~PrimaryFlags ()
bool	isFragment ()
void	setFragment (bool value)
bool	isAdmRecord ()
void	setAdmRecord (bool value)
bool	isFragmentationForbidden ()
void	setFragmentationForbidden (bool value)
bool	isCustodyRequested ()
void	setCustodyRequested (bool value)
bool	isEIDSingleton ()
void	setEIDSingleton (bool value)
bool	isAckOfAppRequested ()
void	setAckOfAppRequested (bool value)
PriorityFlag	getPriority ()
void	setPriority (PriorityFlag value)

---

Detailed Description

class to access the fields of the processing flags of the primary block.

---

Constructor & Destructor Documentation

dtn::data::PrimaryFlags::PrimaryFlags

(

)

default constructor

References dtn::data::BULK, and setPriority().

dtn::data::PrimaryFlags::PrimaryFlags

(

unsigned int

value

)

constructor with a default value.

Parameters:

value

The value of the processing flags.

References dtn::data::BULK, and setPriority().

dtn::data::PrimaryFlags::~PrimaryFlags

(

)

[virtual]

destructor

---

Member Function Documentation

bool dtn::data::PrimaryFlags::isFragment

(

)

Determine if the bundle containts a fragment or not.

Returns:

true, if the bundle contains a fragment.

References dtn::data::FRAGMENT, and dtn::data::ProcessingFlags::getFlag().

Referenced by dtn::data::BundleFactory::cut(), dtn::core::BundleCore::deliver(), dtn::data::StatusReportBlock::match(), dtn::data::CustodySignalBlock::match(), dtn::data::BundleFactory::merge(), dtn::data::BundleFactory::parsePrimaryBlock(), dtn::data::Bundle::setFragment(), dtn::data::StatusReportBlock::setMatch(), dtn::data::CustodySignalBlock::setMatch(), dtn::data::BundleFactory::slice(), and dtn::data::Bundle::updateBlockLength().

void dtn::data::PrimaryFlags::setFragment

(

bool

value

)

Set the fragment block bit.

Parameters:

value

set to true, if the bundle contains a fragment.

References dtn::data::FRAGMENT, and dtn::data::ProcessingFlags::setFlag().

Referenced by dtn::data::Bundle::setFragment().

bool dtn::data::PrimaryFlags::isAdmRecord

(

)

Determine if the bundle contains a administrative record.

Returns:

true, if the bundle contains a administrative record.

References dtn::data::APPDATA_IS_ADMRECORD, and dtn::data::ProcessingFlags::getFlag().

void dtn::data::PrimaryFlags::setAdmRecord

(

bool

value

)

Set the administrative record bit.

Parameters:

value

set to true, if the bundle contains a administrative record.

References dtn::data::APPDATA_IS_ADMRECORD, and dtn::data::ProcessingFlags::setFlag().

Referenced by dtn::data::Bundle::appendBlock(), and dtn::data::Bundle::insertBlock().

bool dtn::data::PrimaryFlags::isFragmentationForbidden

(

)

Determine if fragmentation for this bundle is forbidden or not.

Returns:

true, if fragmentation if forbidden.

References dtn::data::DONT_FRAGMENT, and dtn::data::ProcessingFlags::getFlag().

Referenced by dtn::data::BundleFactory::cut(), and dtn::data::BundleFactory::slice().

void dtn::data::PrimaryFlags::setFragmentationForbidden

(

bool

value

)

Set the fragmentation forbidden bit.

Parameters:

value

Set to true, if fragmentation should be forbidden for this bundle.

References dtn::data::DONT_FRAGMENT, and dtn::data::ProcessingFlags::setFlag().

bool dtn::data::PrimaryFlags::isCustodyRequested

(

)

Determine, if custody transfer is requested for this bundle.

Returns:

true, if custody transfer is requested.

References dtn::data::CUSTODY_REQUESTED, and dtn::data::ProcessingFlags::getFlag().

Referenced by dtn::core::CustodyManager::acceptCustody(), dtn::core::EventDebugger::raiseEvent(), dtn::core::AbstractBundleStorage::raiseEvent(), dtn::core::CustodyManager::rejectCustody(), dtn::core::SimpleBundleStorage::storeFragment(), and dtn::core::BundleCore::transmit().

void dtn::data::PrimaryFlags::setCustodyRequested

(

bool

value

)

Set the custody transfer requested bit.

Parameters:

value

Set to true, if custody transfer should be requested.

References dtn::data::CUSTODY_REQUESTED, and dtn::data::ProcessingFlags::setFlag().

Referenced by dtn::daemon::TestApplication::reportIt(), and emma::MeasurementWorker::tick().

bool dtn::data::PrimaryFlags::isEIDSingleton

(

)

Determine, if the destination EID is a singleton.

Returns:

true, if the destination EID is a singleton.

References dtn::data::DESTINATION_IS_SINGLETON, and dtn::data::ProcessingFlags::getFlag().

void dtn::data::PrimaryFlags::setEIDSingleton

(

bool

value

)

Set the destination EID is a singleton bit.

Parameters:

value

Set to true, if the destination EID is a singleton.

References dtn::data::DESTINATION_IS_SINGLETON, and dtn::data::ProcessingFlags::setFlag().

Referenced by dtn::data::BundleFactory::newBundle().

bool dtn::data::PrimaryFlags::isAckOfAppRequested

(

)

Determine, if the acknowledgment of the application is requested.

Returns:

true, if the acknowledgment of the application is requested.

References dtn::data::ACKOFAPP_REQUESTED, and dtn::data::ProcessingFlags::getFlag().

void dtn::data::PrimaryFlags::setAckOfAppRequested

(

bool

value

)

Set the application acknowledgment of application bit.

Parameters:

value

Set to true, if acknowledgment of the application should be requested.

References dtn::data::ACKOFAPP_REQUESTED, and dtn::data::ProcessingFlags::setFlag().

PriorityFlag dtn::data::PrimaryFlags::getPriority

(

)

Get the priority of the bundle.

Returns:

A value for the priority of the bundle.

References dtn::data::BULK, dtn::data::EXPEDITED, dtn::data::ProcessingFlags::getFlag(), dtn::data::NORMAL, dtn::data::PRIORITY_BIT1, dtn::data::PRIORITY_BIT2, and dtn::data::RESERVED.

void dtn::data::PrimaryFlags::setPriority

(

PriorityFlag

value

)

Set the priority of the bundle.

Parameters:

value

The priority for the bundle.

References dtn::data::BULK, dtn::data::EXPEDITED, dtn::data::NORMAL, dtn::data::PRIORITY_BIT1, dtn::data::PRIORITY_BIT2, dtn::data::RESERVED, and dtn::data::ProcessingFlags::setFlag().

Referenced by PrimaryFlags(), and emma::EmmaConvergenceLayer::yell().

---

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

• include/data/PrimaryFlags.h
• src/data/PrimaryFlags.cpp