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 ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

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)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

This aggregator sends values it receives to a file.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.

Attributes defined in parent class ns3::DataCollectionObject

Name: Object's name
- Set with class: StringValue
- Underlying type:
- Initial value: unnamed
- Flags: construct write read
Enabled: Object's enabled status
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 672 bytes (on a 64-bit architecture).

Definition at line 39 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 46 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 82 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 36 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 173 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 110 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 117 of file file-aggregator.cc.

References m_2dFormat, and NS_LOG_FUNCTION.

Referenced by anonymous_namespace{file-aggregator-example.cc}::CreateFormattedFile().

Here is the caller graph for this 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 124 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 131 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 138 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 145 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 152 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 159 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 166 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 89 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 96 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 629 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 180 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 218 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(), anonymous_namespace{file-aggregator-example.cc}::CreateCommaSeparatedFile(), anonymous_namespace{file-aggregator-example.cc}::CreateFormattedFile(), and anonymous_namespace{file-aggregator-example.cc}::CreateSpaceSeparatedFile().

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 259 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 303 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 350 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 400 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 453 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 509 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.