carma::control::SystemState Interface Reference

Interface for retrieving system state information. More...

import "carma/control/SystemState.idl";

Public Member Functions
unsigned long	getNewestStateFrame () raises ( carma::util::UserException )
	Retrieve the most recent frame for which saved state is available. More...
unsigned long	getOldestStateFrame () raises ( carma::util::UserException )
	Retrieve the oldest frame for which saved state is available. More...
SeqULong	getStateChangeFrames (in SeqString names, in unsigned long begin, in unsigned long end) raises ( carma::util::UserException )
	Retrieve a sequence of frames indicating state change times for the input canonical monitor point names. More...
StateTransportMonitorValueSeq	getStateValues (in SeqString names, in unsigned long frame) raises ( carma::util::UserException )
	Given a list of canonical monitor point names and a frame, return the saved state values for that frame in time. More...

Detailed Description

Interface for retrieving system state information.

Definition at line 35 of file SystemState.idl.

Member Function Documentation

unsigned long carma::control::SystemState::getNewestStateFrame	(		)
raises	(	carma::util::UserException
	)

Retrieve the most recent frame for which saved state is available.

Returns

Frame of most recent saved state.

unsigned long carma::control::SystemState::getOldestStateFrame	(		)
raises	(	carma::util::UserException
	)

Retrieve the oldest frame for which saved state is available.

Returns

Frame of oldest saved state.

SeqULong carma::control::SystemState::getStateChangeFrames	(	in SeqString	names,
		in unsigned long	begin,
		in unsigned long	end
	)
raises	(	carma::util::UserException
	)

Retrieve a sequence of frames indicating state change times for the input canonical monitor point names.

Parameters

names	Canonical monitor point names.
begin	Frame to begin searching (frame inclusive).
end	Frame to end searching (frame inclusive).

Returns

A possibly empty list of state change frames in given range.

StateTransportMonitorValueSeq carma::control::SystemState::getStateValues	(	in SeqString	names,
		in unsigned long	frame
	)
raises	(	carma::util::UserException
	)

Given a list of canonical monitor point names and a frame, return the saved state values for that frame in time.

Values that have changed from the previous saved state will be marked 'changed' in the return structure.

See Also

getStateChangeFrames

Parameters

names	Canonical monitor point names to retrieve values for.
frame	Frame which to return data for - use getStateChangeFrames.

Returns

A possibly empty list of values.

---

The documentation for this interface was generated from the following file:

• carma/control/SystemState.idl