ScriptRobot
 All Classes Functions Typedefs Enumerations Enumerator
PackageSection Class Reference

PackageSection class. More...

#include <PackageSection.h>

Public Member Functions

  PackageSection ()
  PackageSection constructor. More...
 
  PackageSection (std::string name, std::string file)
  Section constructor. More...
 
  ~PackageSection ()
  Section destructor.
 
void  setup (std::string name, std::string file)
  Sets the name and file of a PackageSection. More...
 
void  setName (std::string name)
  Sets the name of the PackageSection. More...
 
std::string  getName ()
  Returns the name of the PackageSection. More...
 
void  setFile (std::string file)
  Sets the PackageSection file. More...
 
std::string  getFile ()
  Returns the PackageSection file as a string. More...
 
int  getNameSize ()
  Returns the number of bytes in the name. More...
 
int  getFileSize ()
  Returns the number of bytes in the file. More...
 

Detailed Description

PackageSection class.

Represents a file stored in memory as a string with its file name.

Constructor & Destructor Documentation

PackageSection::PackageSection ( )

PackageSection constructor.

Creates an empty instance of a PackageSection class with nameSize and fileSize set to 0.

PackageSection::PackageSection ( std::string  name,
std::string  file 
)

Section constructor.

Creates an empty instance of a PackageSection class. Then calls setup(std::string, std::string) on it with the parameters passed in.

See Also
setup(std::string, std::string)
Parameters
name the name of the PackageSection.
file the Section file as a string.

Member Function Documentation

std::string PackageSection::getFile ( )

Returns the PackageSection file as a string.

Returns
the PackageSection file as a string.
int PackageSection::getFileSize ( )

Returns the number of bytes in the file.

Returns
the number of bytes in the file.
std::string PackageSection::getName ( )

Returns the name of the PackageSection.

Returns
the name of the PackageSection.
int PackageSection::getNameSize ( )

Returns the number of bytes in the name.

Returns
the number of bytes in the name.
void PackageSection::setFile ( std::string  file )

Sets the PackageSection file.

This can only be done if the Section file was not previously set.

Parameters
file the Section file as a string.
void PackageSection::setName ( std::string  name )

Sets the name of the PackageSection.

This can only be done if the name was not previously set.

Parameters
name the name of the PackageSection.
void PackageSection::setup ( std::string  name,
std::string  file 
)

Sets the name and file of a PackageSection.

This will only work if the name or file were not previously set.

Parameters
name the name of the PackageSection.
file the Section file as a string.

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