dtn::data::AdministrativeBlock Class Reference

#include <AdministrativeBlock.h>

Inheritance diagram for dtn::data::AdministrativeBlock:

List of all members.

Public Member Functions
	AdministrativeBlock (Block *block, AdministrativeBlockType type)
	AdministrativeBlock (NetworkFrame *frame, AdministrativeBlockType type)
virtual	~AdministrativeBlock ()
virtual AdministrativeBlockType	getAdministrativeType () const
ProcessingFlags	getStatusFlags () const
void	setStatusFlags (ProcessingFlags flags)
bool	isAdministrativeBlock () const
Static Public Member Functions
static AdministrativeBlockType	identify (PayloadBlock *block)
Private Attributes
AdministrativeBlockType	m_type

---

Detailed Description

base class for administrative blocks

---

Constructor & Destructor Documentation

dtn::data::AdministrativeBlock::AdministrativeBlock	(	Block *	block,
		AdministrativeBlockType	type
	)

Use a existing Block to create a new AdministrativeBlock-Object. The used Block will be deleted.

Parameters:

[in]	block	The block to use as base.
[in]	type	The type of the AdministrativeBlock to create.

dtn::data::AdministrativeBlock::AdministrativeBlock	(	NetworkFrame *	frame,
		AdministrativeBlockType	type
	)

Use a existing NetworkFrame to create a new AdministrativeBlock-Object.

Parameters:

[in]	frame	The NetworkFrame to use as base.
[in]	type	The type of the AdministrativeBlock to create.

References dtn::data::NetworkFrame::getFieldSizeMap().

dtn::data::AdministrativeBlock::~AdministrativeBlock

(

)

[virtual]

Destructor for the AdministrativeBlock.

---

Member Function Documentation

AdministrativeBlockType dtn::data::AdministrativeBlock::getAdministrativeType

(

)

const [virtual]

Get the type of a AdministrativeBlock-Instance.

Returns:

A type of the AdministrationBlockType enumeration.

References m_type.

ProcessingFlags dtn::data::AdministrativeBlock::getStatusFlags

(

)

const

Get the StatusFlags as a ProcessingFlags-Object.

Returns:

The StatusFlags as object.

References dtn::data::Block::getBodyIndex(), dtn::data::NetworkFrame::getChar(), and dtn::data::Block::getFrame().

Referenced by dtn::core::BundleCore::createStatusReport(), dtn::data::StatusReportBlock::forFragment(), dtn::data::CustodySignalBlock::forFragment(), dtn::data::StatusReportBlock::setFragmentLength(), dtn::data::CustodySignalBlock::setFragmentLength(), dtn::data::StatusReportBlock::setFragmentOffset(), and dtn::data::CustodySignalBlock::setFragmentOffset().

void dtn::data::AdministrativeBlock::setStatusFlags

(

ProcessingFlags

flags

)

Set the status flags of the block.

Parameters:

[in]

flags

The status flags to set.

References dtn::data::Block::getBodyIndex(), dtn::data::Block::getFrame(), dtn::data::ProcessingFlags::getValue(), and dtn::data::NetworkFrame::set().

Referenced by dtn::core::BundleCore::createStatusReport(), dtn::data::StatusReportBlock::setFragmentLength(), dtn::data::CustodySignalBlock::setFragmentLength(), dtn::data::StatusReportBlock::setFragmentOffset(), and dtn::data::CustodySignalBlock::setFragmentOffset().

AdministrativeBlockType dtn::data::AdministrativeBlock::identify

(

PayloadBlock *

block

)

[static]

Identify a PayloadBlock which is a AdministrativeBlock of a specific type.

Returns:

The type of the block represented by a AdministrationBlockType enumeration.

References dtn::data::PayloadBlock::getPayload().

Referenced by dtn::data::PayloadBlockFactory::castAdministrativeBlock(), and dtn::data::PayloadBlockFactory::copy().

bool dtn::data::AdministrativeBlock::isAdministrativeBlock

(

)

const [virtual]

returns true, if this is a administrative block like CustodySignalBlock.

Reimplemented from dtn::data::Block.

---

Member Data Documentation

AdministrativeBlockType dtn::data::AdministrativeBlock::m_type [private]

Referenced by getAdministrativeType().

---

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

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