API Documentation

SdfHostConfiguration Class

The Host Configuration from the System Design File.

SdfHostConfiguration::SdfHostConfiguration ( )

A default constructor.

SdfHostConfiguration::SdfHostConfiguration ( … )

A copy constructor.

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

SdfHostConfiguration::SdfHostConfiguration ( … )

A convenience constructor from a related type.

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

SdfHostConfiguration::~SdfHostConfiguration ( )

A default destructor.

SdfHostConfiguration::print ( … )

This will print internal values.

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

SdfHostConfiguration::get_ps_sdf_host_configuration ( ) const

This will provide convenient access to a related type.

Returns

SdfHostConfiguration::operator= ( … )

An assignment operator.

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

SdfHostConfiguration::getId ( ) const

This will get the identifier of the configuration.

Returns
  • unsigned long

SdfHostConfiguration::getRuntimeConfigurationId ( ) const

This will get the identifier of the parent runtime configuration.

Returns
  • unsigned long

SdfHostConfiguration::getParameterListId ( ) const

This will get the identifier of the parameter list.

Returns
  • unsigned long

SdfHostConfiguration::getEnabled ( ) const

This will get the flag indicating if the host is enabled.

Returns
  • unsigned char

SdfHostConfiguration::getName ( ) const

This will get the name of the configuration.

Returns
  • std::string

SdfHostConfiguration::getInterfaceAddress ( ) const

This will get the interface address.

Returns
  • std::string

SdfHostConfiguration::getLicenseFile ( ) const

This will get the license file path.

Returns
  • std::string

SdfHostConfiguration::getRnrBaseDir ( ) const

This will get the record and replay base directory path.

Returns
  • std::string

SdfHostConfiguration::getNodeConfigs ( ) const

This will get the vector of the child SdfNodeConfiguration.

Returns

SdfHostConfiguration::getParameterValues ( ) const

This will get the vector of the parameter values.

Returns

SdfHostConfiguration::setId ( … )

This will set the identifier of the configuration.

Parameters
in/out type description
in unsigned long The set identifier value.
Returns
  • void

SdfHostConfiguration::setRuntimeConfigurationId ( … )

This will set the identifier of the parent runtime configuration.

Parameters
in/out type description
in unsigned long The set identifier value.
Returns
  • void

SdfHostConfiguration::setParameterListId ( … )

This will set the identifier of the parameter list.

Parameters
in/out type description
in unsigned long The set identifier value.
Returns
  • void

SdfHostConfiguration::setEnabled ( … ) const

This will set flag that indicates if node is enabled.

Parameters
in/out type description
in unsigned char The enabled flag value.
Returns
  • void

SdfHostConfiguration::setName ( … )

This will set the name of the configuration.

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

SdfHostConfiguration::setInterfaceAddress ( … )

This will set the interface address.

Parameters
in/out type description
in const std::string & The set interface address.
Returns
  • void

SdfHostConfiguration::setLicenseFile ( … )

This will set the license file path.

Parameters
in/out type description
in const std::string & The set license file path.
Returns
  • void

SdfHostConfiguration::setRnrBaseDir ( … )

This will set the record and replay base directory path.

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

SdfHostConfiguration::setNodeConfigs ( … )

This will set the vector of the child SdfNodeConfiguration.

Parameters
in/out type description
in const std::vector< SdfNodeConfiguration > & The set child configurations.
Returns
  • void

SdfHostConfiguration::setParameterValues ( … )

This will set the vector of the parameter values.

Parameters
in/out type description
in const std::vector< SdfParameterValue > & The set parameter values.
Returns
  • void