This aggregator sends values it receives to a file. More...

#include <file-aggregator.h>

Inheritance diagram for ns3::FileAggregator:

Collaboration diagram for ns3::FileAggregator:

Public Types
enum	FileType { FORMATTED, SPACE_SEPARATED, COMMA_SEPARATED, TAB_SEPARATED }
	The type of file written by the aggregator. More...

Public Member Functions
	FileAggregator (const std::string &outputFileName, enum FileType fileType=SPACE_SEPARATED)

virtual	~FileAggregator ()

void	Set10dFormat (const std::string &format)
	Sets the 10D format string for the C-style sprintf() function. More...

void	Set1dFormat (const std::string &format)
	Sets the 1D format string for the C-style sprintf() function. More...

void	Set2dFormat (const std::string &format)
	Sets the 2D format string for the C-style sprintf() function. More...

void	Set3dFormat (const std::string &format)
	Sets the 3D format string for the C-style sprintf() function. More...

void	Set4dFormat (const std::string &format)
	Sets the 4D format string for the C-style sprintf() function. More...

void	Set5dFormat (const std::string &format)
	Sets the 5D format string for the C-style sprintf() function. More...

void	Set6dFormat (const std::string &format)
	Sets the 6D format string for the C-style sprintf() function. More...

void	Set7dFormat (const std::string &format)
	Sets the 7D format string for the C-style sprintf() function. More...

void	Set8dFormat (const std::string &format)
	Sets the 8D format string for the C-style sprintf() function. More...

void	Set9dFormat (const std::string &format)
	Sets the 9D format string for the C-style sprintf() function. More...

void	SetFileType (enum FileType fileType)
	Set the file type to create, which determines the separator to use when printing values to the file. More...

void	SetHeading (const std::string &heading)
	Sets the heading string that will be printed on the first line of the file. More...

void	Write10d (std::string context, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9, double v10)
	Writes 10 values to the file. More...

void	Write1d (std::string context, double v1)
	Writes 1 value to the file. More...

void	Write2d (std::string context, double v1, double v2)
	Writes 2 values to the file. More...

void	Write3d (std::string context, double v1, double v2, double v3)
	Writes 3 values to the file. More...

void	Write4d (std::string context, double v1, double v2, double v3, double v4)
	Writes 4 values to the file. More...

void	Write5d (std::string context, double v1, double v2, double v3, double v4, double v5)
	Writes 5 values to the file. More...

void	Write6d (std::string context, double v1, double v2, double v3, double v4, double v5, double v6)
	Writes 6 values to the file. More...

void	Write7d (std::string context, double v1, double v2, double v3, double v4, double v5, double v6, double v7)
	Writes 7 values to the file. More...

void	Write8d (std::string context, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8)
	Writes 8 values to the file. More...

void	Write9d (std::string context, double v1, double v2, double v3, double v4, double v5, double v6, double v7, double v8, double v9)
	Writes 9 values to the file. More...

Public Member Functions inherited from ns3::DataCollectionObject
	DataCollectionObject ()

virtual	~DataCollectionObject ()

void	Disable (void)
	Unset the status of an individual object. More...

void	Enable (void)
	Set the status of an individual object. More...

std::string	GetName (void) const
	Get the object's name. More...

virtual bool	IsEnabled (void) const
	Check the status of an individual object. More...

void	SetName (std::string name)
	Set the object's name. All spaces are replaced by underscores. More...

Public Member Functions inherited from ns3::Object
	Object ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::DataCollectionObject
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Attributes
std::string	m_10dFormat
	Format string for 10D C-style sprintf() function. More...

std::string	m_1dFormat
	Format string for 1D C-style sprintf() function. More...

std::string	m_2dFormat
	Format string for 2D C-style sprintf() function. More...

std::string	m_3dFormat
	Format string for 3D C-style sprintf() function. More...

std::string	m_4dFormat
	Format string for 4D C-style sprintf() function. More...

std::string	m_5dFormat
	Format string for 5D C-style sprintf() function. More...

std::string	m_6dFormat
	Format string for 6D C-style sprintf() function. More...

std::string	m_7dFormat
	Format string for 7D C-style sprintf() function. More...

std::string	m_8dFormat
	Format string for 8D C-style sprintf() function. More...

std::string	m_9dFormat
	Format string for 9D C-style sprintf() function. More...

std::ofstream	m_file
	Used to write values to the file. More...

enum FileType	m_fileType
	Determines the kind of file written by the aggregator. More...

bool	m_hasHeadingBeenSet
	Indicates if the heading line for the file has been set. More...

std::string	m_heading
	Heading line for the outputfile. More...

std::string	m_outputFileName
	The file name. More...

std::string	m_separator
	Printed between values in the file. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Protected Attributes inherited from ns3::DataCollectionObject
bool	m_enabled
	Object's activation state. More...

std::string	m_name
	Name of the object within the data collection framework. More...

Detailed Description

This aggregator sends values it receives to a file.

Doxygen introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 39 of file file-aggregator.h.

Member Enumeration Documentation

enum ns3::FileAggregator::FileType

The type of file written by the aggregator.

Enumerator
FORMATTED
SPACE_SEPARATED
COMMA_SEPARATED
TAB_SEPARATED

Definition at line 43 of file file-aggregator.h.

Constructor & Destructor Documentation

ns3::FileAggregator::FileAggregator	(	const std::string &	outputFileName,
		enum FileType	fileType = `SPACE_SEPARATED`
	)

Parameters

outputFileName	name of the file to write.
fileType	type of file to write.

Constructs a file aggregator that will create a file named outputFileName with values printed as specified by fileType. The default file type is space-separated.

Definition at line 47 of file file-aggregator.cc.

References COMMA_SEPARATED, m_file, m_fileType, m_outputFileName, m_separator, NS_LOG_FUNCTION, and TAB_SEPARATED.

ns3::FileAggregator::~FileAggregator ( )

virtual

Definition at line 83 of file file-aggregator.cc.

References m_file, and NS_LOG_FUNCTION.

Member Function Documentation

TypeId ns3::FileAggregator::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 38 of file file-aggregator.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::FileAggregator::Set10dFormat ( const std::string & format )

Sets the 10D format string for the C-style sprintf() function.

Parameters

format the 10D format string.

Definition at line 174 of file file-aggregator.cc.

References m_10dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set1dFormat ( const std::string & format )

Sets the 1D format string for the C-style sprintf() function.

Parameters

format the 1D format string.

Definition at line 111 of file file-aggregator.cc.

References m_1dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set2dFormat ( const std::string & format )

Sets the 2D format string for the C-style sprintf() function.

Parameters

format the 2D format string.

Definition at line 118 of file file-aggregator.cc.

References m_2dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set3dFormat ( const std::string & format )

Sets the 3D format string for the C-style sprintf() function.

Parameters

format the 3D format string.

Definition at line 125 of file file-aggregator.cc.

References m_3dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set4dFormat ( const std::string & format )

Sets the 4D format string for the C-style sprintf() function.

Parameters

format the 4D format string.

Definition at line 132 of file file-aggregator.cc.

References m_4dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set5dFormat ( const std::string & format )

Sets the 5D format string for the C-style sprintf() function.

Parameters

format the 5D format string.

Definition at line 139 of file file-aggregator.cc.

References m_5dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set6dFormat ( const std::string & format )

Sets the 6D format string for the C-style sprintf() function.

Parameters

format the 6D format string.

Definition at line 146 of file file-aggregator.cc.

References m_6dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set7dFormat ( const std::string & format )

Sets the 7D format string for the C-style sprintf() function.

Parameters

format the 7D format string.

Definition at line 153 of file file-aggregator.cc.

References m_7dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set8dFormat ( const std::string & format )

Sets the 8D format string for the C-style sprintf() function.

Parameters

format the 8D format string.

Definition at line 160 of file file-aggregator.cc.

References m_8dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Set9dFormat ( const std::string & format )

Sets the 9D format string for the C-style sprintf() function.

Parameters

format the 9D format string.

Definition at line 167 of file file-aggregator.cc.

References m_9dFormat, and NS_LOG_FUNCTION.

void ns3::FileAggregator::SetFileType ( enum FileType fileType )

Set the file type to create, which determines the separator to use when printing values to the file.

Parameters

fileType file type specifies the separator to use in printing the file.

Definition at line 90 of file file-aggregator.cc.

References m_fileType, and NS_LOG_FUNCTION.

void ns3::FileAggregator::SetHeading ( const std::string & heading )

Sets the heading string that will be printed on the first line of the file.

Parameters

heading the heading string.

Note that the heading string will only be printed if it has been set by calling this function.

Definition at line 97 of file file-aggregator.cc.

References m_file, m_hasHeadingBeenSet, m_heading, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write10d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5,
		double	v6,
		double	v7,
		double	v8,
		double	v9,
		double	v10
	)

Writes 10 values to the file.

Parameters

context	specifies the 10D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.
v6	sixth value for the new data point.
v7	seventh value for the new data point.
v8	eighth value for the new data point.
v9	nineth value for the new data point.
v10	tenth value for the new data point.

Definition at line 630 of file file-aggregator.cc.

References FORMATTED, m_10dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write1d	(	std::string	context,
		double	v1
	)

Writes 1 value to the file.

Parameters

context	specifies the 1D dataset these values came from.
v1	value for the new data point.

Definition at line 181 of file file-aggregator.cc.

References FORMATTED, m_1dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write2d	(	std::string	context,
		double	v1,
		double	v2
	)

Writes 2 values to the file.

Parameters

context	specifies the 2D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.

Definition at line 219 of file file-aggregator.cc.

References FORMATTED, m_2dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by ns3::FileHelper::ConnectProbeToAggregator().

Here is the caller graph for this function:

void ns3::FileAggregator::Write3d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3
	)

Writes 3 values to the file.

Parameters

context	specifies the 3D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.

Definition at line 260 of file file-aggregator.cc.

References FORMATTED, m_3dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write4d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4
	)

Writes 4 values to the file.

Parameters

context	specifies the 4D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.

Definition at line 304 of file file-aggregator.cc.

References FORMATTED, m_4dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write5d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5
	)

Writes 5 values to the file.

Parameters

context	specifies the 5D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.

Definition at line 351 of file file-aggregator.cc.

References FORMATTED, m_5dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write6d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5,
		double	v6
	)

Writes 6 values to the file.

Parameters

context	specifies the 6D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.
v6	sixth value for the new data point.

Definition at line 401 of file file-aggregator.cc.

References FORMATTED, m_6dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write7d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5,
		double	v6,
		double	v7
	)

Writes 7 values to the file.

Parameters

context	specifies the 7D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.
v6	sixth value for the new data point.
v7	seventh value for the new data point.

Definition at line 454 of file file-aggregator.cc.

References FORMATTED, m_7dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write8d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5,
		double	v6,
		double	v7,
		double	v8
	)

Writes 8 values to the file.

Parameters

context	specifies the 8D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.
v6	sixth value for the new data point.
v7	seventh value for the new data point.
v8	eighth value for the new data point.

Definition at line 510 of file file-aggregator.cc.

References FORMATTED, m_8dFormat, ns3::DataCollectionObject::m_enabled, m_file, m_fileType, m_separator, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

void ns3::FileAggregator::Write9d	(	std::string	context,
		double	v1,
		double	v2,
		double	v3,
		double	v4,
		double	v5,
		double	v6,
		double	v7,
		double	v8,
		double	v9
	)

Writes 9 values to the file.

Parameters

context	specifies the 9D dataset these values came from.
v1	first value for the new data point.
v2	second value for the new data point.
v3	third value for the new data point.
v4	fourth value for the new data point.
v5	fifth value for the new data point.
v6	sixth value for the new data point.
v7	seventh value for the new data point.
v8	eighth value for the new data point.
v9	nineth value for the new data point.