API Documentation

Version Class

This provides a representation of a PolySync API version.

Version::Version ( )

A default constructor.

Version::Version ( … )

A copy constructor.

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

Version::Version ( … )

A convenience constructor from a related type.

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

Version::~Version ( )

A default destructor.

Version::print ( … )

This will print internal values.

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

Version::get_ps_version ( ) const

This will provide convenient access to a related type.

Returns

Version::operator= ( … )

An assignment operator.

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

Version::getMajor ( ) const

This will get the byte value of the major version digit.

Returns
  • unsigned char

Version::getMinor ( ) const

This will get the byte value of the minor version digit.

Returns
  • unsigned char

Version::getSubminor ( ) const

This will get the subminor version digit.

Returns
  • unsigned short

Version::getBuildDate ( ) const

This will get the version build date.

Returns
  • unsigned long [UTC seconds]

Version::setMajor ( … )

This will set the byte value of the major version digit.

Parameters
in/out type description
in unsigned char The major version byte value.

Version::setMinor ( … )

This will set the byte value of the minor version digit.

Parameters
in/out type description
in unsigned char The minor version byte value.

Version::setSubminor ( … )

This will set the value of the subminor version digit.

Parameters
in/out type description
in unsigned short The subminor version value.

Version::setBuildDate ( … )

This will set the version build date.

Parameters
in/out type description
in unsigned long The subminor version value [UTC seconds].