API Documentation

RnrLogfileAttributes

This contains attributes of a PolySync logfile.

RnrLogfileAttributes::RnrLogfileAttributes ( )

A default constructor.

RnrLogfileAttributes::RnrLogfileAttributes ( … )

A copy constructor.

Parameters
in/out type description
in const RnrLogfileAttributes & Instance being copied.

RnrLogfileAttributes::RnrLogfileAttributes ( … )

A convenience constructor from a related type.

Parameters
in/out type description
in const ps_rnr_logfile_attributes & Instance of related type.

RnrLogfileAttributes::~RnrLogfileAttributes ( )

A default destructor.

RnrLogfileAttributes::print ( … )

This will print internal values.

Parameters
in/out type description
in std::ostream & Output stream that defaults to std::cout.
Returns
  • void

RnrLogfileAttributes::get_ps_rnr_logfile_attributes ( ) const

This will provide convenient access to a related type.

Returns

RnrLogfileAttributes::operator= ( … )

An assignment operator.

Parameters
in/out type description
in const RnrLogfileAttributes & Instance to copy.
Returns

RnrLogfileAttributes::getFilename ( ) const

This will get the logfile filename.

Returns
  • std::string

RnrLogfileAttributes::getAbsolutePath ( ) const

This will get the logfile absolute path.

Returns
  • std::string

RnrLogfileAttributes::getNodeName ( ) const

This will get the node name.

Returns
  • std::string

RnrLogfileAttributes::getNodeGuid ( ) const

This will get the node GUID.

Returns

RnrLogfileAttributes::getStartTime ( ) const

This will get the logfile start time [UTC microseconds].

Returns

RnrLogfileAttributes::getEndTime ( ) const

This will get the logfile end time [UTC microseconds].

Returns

RnrLogfileAttributes::getDuration ( ) const

This will get the logfile duration.

Returns

RnrLogfileAttributes::getFileSize ( ) const

This will get the logfile size.

Returns
  • unsigned long

RnrLogfileAttributes::getRecordOffset ( ) const

This will get the offset of the first record in bytes.

Returns
  • unsigned long

RnrLogfileAttributes::getRecordCount ( ) const

This will get the record count.

Returns
  • unsigned long

RnrLogfileAttributes::setFilename ( … )

This will set the logfile filename.

Parameters
in/out type description
in std::string The set logfile filename.
Returns
  • void

RnrLogfileAttributes::setAbsolutePath ( … )

This will set the logfile absolute path.

Parameters
in/out type description
in std::string The set logfile path.
Returns
  • void

RnrLogfileAttributes::setNodeName ( … )

This will set the node name.

Parameters
in/out type description
in std::string The set node name.
Returns
  • void

RnrLogfileAttributes::setNodeGuid ( … )

This will set the node GUID.

Parameters
in/out type description
in ps_guid The set node GUID.
Returns
  • void

RnrLogfileAttributes::setStartTime ( … )

This will set the logfile start time [UTC microseconds].

Parameters
in/out type description
in ps_timestamp The set start time in microseconds.
Returns
  • void

RnrLogfileAttributes::setEndTime ( … )

This will set the logfile end time [UTC microseconds].

Parameters
in/out type description
in ps_timestamp The set end time in microseconds.
Returns
  • void

RnrLogfileAttributes::setDuration ( … )

This will set the logfile duration.

Parameters
in/out type description
in ps_timestamp The duration start time in microseconds.
Returns
  • void

RnrLogfileAttributes::setFileSize ( … )

This will set the logfile size.

Parameters
in/out type description
in unsigned long The set logfile size in bytes.
Returns
  • void

RnrLogfileAttributes::setRecordOffset ( … )

This will set the offset of the first record in bytes.

Parameters
in/out type description
in unsigned long The set record offset in bytes.
Returns
  • void

RnrLogfileAttributes::setRecordCount ( … )

This will set the record count.

Parameters
in/out type description
in unsigned long The number of records in the file.
Returns
  • void