API Documentation

SdfRuntimeConfiguration Class

The Host Configuration from the System Design File.

SdfRuntimeConfiguration::SdfRuntimeConfiguration ( )

A default constructor.

SdfRuntimeConfiguration::SdfRuntimeConfiguration ( … )

A copy constructor.

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

SdfRuntimeConfiguration::SdfRuntimeConfiguration ( … )

A convenience constructor from a related type.

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

SdfRuntimeConfiguration::~SdfRuntimeConfiguration ( )

A default destructor.

SdfRuntimeConfiguration::print ( … )

This will print internal values.

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

SdfRuntimeConfiguration::get_ps_sdf_runtime_configuration ( ) const

This will provide convenient access to a related type.

Returns

SdfRuntimeConfiguration::operator= ( … )

An assignment operator.

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

SdfRuntimeConfiguration::getId ( ) const

This will get the identifier of the configuration.

Returns
  • unsigned long

SdfRuntimeConfiguration::getParameterListId ( ) const

This will get the identifier of the parameter list.

Returns
  • unsigned long

SdfRuntimeConfiguration::getName ( ) const

This will get the name of the configuration.

Returns
  • std::string

SdfRuntimeConfiguration::getDomainId ( ) const

This will get the identifier of the runtime’s domain.

Returns
  • unsigned long

SdfRuntimeConfiguration::getApiVersion ( ) const

This will get the API version of the runtime.

Returns
  • std::string

SdfRuntimeConfiguration::getHostConfigs ( ) const

This will get the vector of a child SdfHostConfiguration.

Returns

SdfRuntimeConfiguration::getParameterValues ( ) const

This will get the vector of the parameter values.

Returns

SdfRuntimeConfiguration::setId ( … )

This will set the identifier of the configuration.

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

SdfRuntimeConfiguration::setParameterListId ( … )

This will set the identifier of the parameter list.

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

SdfRuntimeConfiguration::setName ( … )

This will set the name of the configuration.

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

SdfRuntimeConfiguration::setDomainId ( … )

This will set the domain identifier of the runtime.

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

SdfRuntimeConfiguration::setApiVersion ( … )

This will set the API version of the runtime.

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

SdfRuntimeConfiguration::setHostConfigs ( … )

This will set the vector of a child SdfHostConfiguration.

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

SdfRuntimeConfiguration::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